import { GraphQLClient } from 'graphql-request'; import * as Dom from 'graphql-request/dist/types.dom'; import gql from 'graphql-tag'; export type Maybe = T | null; export type Exact = { [K in keyof T]: T[K] }; export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { ID: string; String: string; Boolean: boolean; Int: number; Float: number; /** Amazon Web Services ARN. */ ARN: any; /** An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) encoded UTC date string. Example value: `"2019-07-16"`. */ Date: any; /** An ISO-8601 encoded UTC date time string. Example value: `"2019-07-03T20:47:55Z"`. */ DateTime: any; /** A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: `"29.99"`. */ Decimal: any; /** * A string containing a strict subset of HTML code. Non-allowed tags will be stripped out. * Allowed tags: * * `a` (allowed attributes: `href`) * * `b` * * `br` * * `em` * * `i` * * `strong` * * `u` * * Example value: `"Your current domain is johns-apparel.myshopify.com."` */ FormattedString: any; /** A string containing HTML code. Example value: `"

Grey cotton knit sweater.

"`. */ HTML: any; /** A JSON Object. Example value: `{ "key1": "Value 1", "key2": "Value 2", "key3": 3 }` */ JSON: any; /** A monetary value string. Example value: `"100.57"`. */ Money: any; /** * Represents a unique identifier in the Storefront API. A `StorefrontID` value can be used wherever an ID is expected in the Storefront API. * * Example value: `"Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzEwMDc5Nzg1MTAw"`. */ StorefrontID: any; /** * An RFC 3986 and RFC 3987 compliant URI string. * * Example value: `"https://johns-apparel.myshopify.com"`. */ URL: any; /** * An unsigned 64-bit integer. Represents whole numeric values between 0 and 2^64 - 1 encoded as a string of base-10 digits. * * Example value: `"50"`. */ UnsignedInt64: any; /** * Time between UTC time and a location's observed time, in the format `"+HH:MM"` or `"-HH:MM"`. * * Example value: `"-07:00"`. */ UtcOffset: any; }; /** Represents the access scope permission that is applicable to a merchant's shop, such as `read_orders`. */ export type AccessScope = { __typename?: 'AccessScope'; /** Description of the access scopes enabled on an api permission. */ description: Scalars['String']; /** A human-friendly string for an access scope. */ handle: Scalars['String']; }; /** Whether all items in the cart are entitled to the discount. */ export type AllDiscountItems = { __typename?: 'AllDiscountItems'; /** Whether all items are selected. The value is hardcoded to `true`. */ allItems: Scalars['Boolean']; }; /** A version of the API. */ export type ApiVersion = { __typename?: 'ApiVersion'; /** The human-readable name of the version. */ displayName: Scalars['String']; /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ handle: Scalars['String']; /** Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/concepts/about-apis/versioning). */ supported: Scalars['Boolean']; }; /** A Shopify application. */ export type App = Node & { __typename?: 'App'; /** A unique application API identifier. */ apiKey: Scalars['String']; /** App store page URL of the app. */ appStoreAppUrl?: Maybe; /** App store page URL of the developer who created the app. */ appStoreDeveloperUrl?: Maybe; /** Banner image for the app. */ banner: Image; /** Description of the app. */ description?: Maybe; /** App's developer name. */ developerName?: Maybe; /** * Website of the developer who created the app. * @deprecated Use `appStoreDeveloperUrl` instead */ developerUrl: Scalars['URL']; /** Whether the app uses the Embedded App SDK. */ embedded: Scalars['Boolean']; /** Requirements that must be met before the app can be installed. */ failedRequirements: Array; /** List of app features. */ features: Array; /** Feedback from this app about the store. */ feedback?: Maybe; /** Handle of the app. */ handle?: Maybe; /** Icon that represents the app. */ icon: Image; /** Globally unique identifier. */ id: Scalars['ID']; /** Webpage where you can install the app. */ installUrl?: Maybe; /** * Corresponding AppInstallation for this shop and App. * Returns null if the App is not installed. */ installation?: Maybe; /** * Webpage that the app starts in. * @deprecated Use AppInstallation.launchUrl instead */ launchUrl: Scalars['URL']; /** * Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin. * @deprecated Use AppInstallation.navigationItems instead */ navigationItems: Array; /** Detailed information about the app pricing. */ pricingDetails?: Maybe; /** Summary of the app pricing details. */ pricingDetailsSummary: Scalars['String']; /** Link to app privacy policy. */ privacyPolicyUrl?: Maybe; /** Whether the app is published. */ published: Scalars['Boolean']; /** Screenshots of the app. */ screenshots: Array; /** Whether the app was developed by Shopify. */ shopifyDeveloped: Scalars['Boolean']; /** Name of the app. */ title: Scalars['String']; /** * Message that appears when the app is uninstalled. For example: * By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time. */ uninstallMessage: Scalars['String']; /** * Webpage where you can uninstall the app. * @deprecated Use AppInstallation.uninstallUrl instead */ uninstallUrl?: Maybe; }; /** An auto-generated type for paginating through multiple Apps. */ export type AppConnection = { __typename?: 'AppConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify. */ export type AppCredit = Node & { __typename?: 'AppCredit'; /** The amount that can be used towards future app purchases in Shopify. */ amount: MoneyV2; /** The date and time when the app credit was created. */ createdAt: Scalars['DateTime']; /** The description of the app credit. */ description: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** Whether the app credit is a test transaction. */ test: Scalars['Boolean']; }; /** An auto-generated type for paginating through multiple AppCredits. */ export type AppCreditConnection = { __typename?: 'AppCreditConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `appCreditCreate` mutation. */ export type AppCreditCreatePayload = { __typename?: 'AppCreditCreatePayload'; /** The newly created app credit. */ appCredit?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one AppCredit and a cursor during pagination. */ export type AppCreditEdge = { __typename?: 'AppCreditEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of AppCreditEdge. */ node: AppCredit; }; /** An auto-generated type which holds one App and a cursor during pagination. */ export type AppEdge = { __typename?: 'AppEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of AppEdge. */ node: App; }; /** * Reports the status of shops and their resources and displays this information * within Shopify admin. AppFeedback is used to notify merchants about steps they need to take * to set up an app on their store. */ export type AppFeedback = { __typename?: 'AppFeedback'; /** The application associated to the feedback. */ app: App; /** A link to where merchants can resolve errors. */ link?: Maybe; /** The feedback message presented to the merchant. */ messages: Array; }; /** Represents an installed application on a shop. */ export type AppInstallation = Node & { __typename?: 'AppInstallation'; /** Access scopes granted to an app by a merchant during installation. */ accessScopes: Array; /** Active subscriptions charged to a shop on a recurring basis. */ activeSubscriptions: Array; /** All subscriptions created for a shop. */ allSubscriptions: AppSubscriptionConnection; /** Application which is installed. */ app: App; /** * Channel associated with the installed application. * @deprecated Use `publication` instead */ channel?: Maybe; /** Credits that can be used towards future app purchases. */ credits: AppCreditConnection; /** Globally unique identifier. */ id: Scalars['ID']; /** Url used to launch the app. */ launchUrl: Scalars['URL']; /** One-time purchases to a shop. */ oneTimePurchases: AppPurchaseOneTimeConnection; /** Publication associated with the installed application. */ publication?: Maybe; /** The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes. */ revenueAttributionRecords: AppRevenueAttributionRecordConnection; /** * Subscriptions charge to a shop on a recurring basis. * @deprecated Use `activeSubscriptions` instead */ subscriptions: Array; /** Webpage where you can uninstall the app. */ uninstallUrl?: Maybe; }; /** Represents an installed application on a shop. */ export type AppInstallationAllSubscriptionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Represents an installed application on a shop. */ export type AppInstallationCreditsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Represents an installed application on a shop. */ export type AppInstallationOneTimePurchasesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Represents an installed application on a shop. */ export type AppInstallationRevenueAttributionRecordsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Possible categories of an app installation. */ export enum AppInstallationCategory { /** Sales channel apps. */ Channel = 'CHANNEL', /** Apps that can be used in the POS mobile client. */ PosEmbedded = 'POS_EMBEDDED' } /** An auto-generated type for paginating through multiple AppInstallations. */ export type AppInstallationConnection = { __typename?: 'AppInstallationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one AppInstallation and a cursor during pagination. */ export type AppInstallationEdge = { __typename?: 'AppInstallationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of AppInstallationEdge. */ node: AppInstallation; }; /** Possible privacy types of an app installation. */ export enum AppInstallationPrivacy { Public = 'PUBLIC', Private = 'PRIVATE' } /** The set of valid sort keys for the AppInstallation query. */ export enum AppInstallationSortKeys { /** Sort by the `installed_at` value. */ InstalledAt = 'INSTALLED_AT', /** Sort by the `app_title` value. */ AppTitle = 'APP_TITLE', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Defines the pricing model for the app subscription. */ export type AppPlanInput = { /** Usage based billing pricing details. */ appUsagePricingDetails?: Maybe; /** Recurring based billing pricing details. */ appRecurringPricingDetails?: Maybe; }; /** Defines the app plan the merchant is subscribed to. */ export type AppPlanV2 = { __typename?: 'AppPlanV2'; /** Defines the pricing model for the app subscription. */ pricingDetails: AppPricingDetails; }; /** Information about the price charged to a shop every plan period. */ export type AppPricingDetails = AppRecurringPricing | AppUsagePricing; /** The billing frequency for the app. */ export enum AppPricingInterval { /** The merchant is billed for this app annually. */ Annual = 'ANNUAL', /** The merchant is billed for this app every 30 days. */ Every_30Days = 'EVERY_30_DAYS' } /** Services and features purchased once by the store. */ export type AppPurchase = { /** The date and time when the app purchase was created. */ createdAt: Scalars['DateTime']; /** The name of the app purchase. */ name: Scalars['String']; /** The amount to be charged to the store for the app purchase. */ price: MoneyV2; /** The status of the app purchase. Possible values include pending, active, declined and cancelled. */ status: AppPurchaseStatus; /** Whether the app purchase is a test transaction. */ test: Scalars['Boolean']; }; /** Services and features purchased once by a store. */ export type AppPurchaseOneTime = AppPurchase & Node & { __typename?: 'AppPurchaseOneTime'; /** The date and time when the app purchase was created. */ createdAt: Scalars['DateTime']; /** Globally unique identifier. */ id: Scalars['ID']; /** The name of the app purchase. */ name: Scalars['String']; /** The amount to be charged to the store for the app purchase. */ price: MoneyV2; /** The status of the app purchase. Possible values include pending, active, declined and cancelled. */ status: AppPurchaseStatus; /** Whether the app purchase is a test transaction. */ test: Scalars['Boolean']; }; /** An auto-generated type for paginating through multiple AppPurchaseOneTimes. */ export type AppPurchaseOneTimeConnection = { __typename?: 'AppPurchaseOneTimeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `appPurchaseOneTimeCreate` mutation. */ export type AppPurchaseOneTimeCreatePayload = { __typename?: 'AppPurchaseOneTimeCreatePayload'; /** The newly created app one-time purchase. */ appPurchaseOneTime?: Maybe; /** The URL where the merchant can approve or decline the app one-time purchase. */ confirmationUrl?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination. */ export type AppPurchaseOneTimeEdge = { __typename?: 'AppPurchaseOneTimeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of AppPurchaseOneTimeEdge. */ node: AppPurchaseOneTime; }; /** The status of the purchase. */ export enum AppPurchaseStatus { /** The app purchase has been approved by the merchant and is ready to be activated by the app. App purchases created through the GraphQL Admin API are activated upon approval. */ Accepted = 'ACCEPTED', /** The app purchase has been activated by the app. Active app purchases are charged to the store and partners receive payouts for active app purchase. */ Active = 'ACTIVE', /** The app purchase was declined by the merchant. */ Declined = 'DECLINED', /** The app purchase was not accepted within 2 days of being created. */ Expired = 'EXPIRED', /** The app purchase is pending approval by the merchant. */ Pending = 'PENDING' } /** Price charged every interval. */ export type AppRecurringPricing = { __typename?: 'AppRecurringPricing'; /** Specifies the number of days in a billing cycle of the app subscription. */ interval: AppPricingInterval; /** The amount to be charged to the store every billing interval. */ price: MoneyV2; }; /** Allows an app to charge per billing interval. */ export type AppRecurringPricingInput = { /** Specifies the billing frequency of the app subscription. */ interval?: Maybe; /** The amount to be charged to the store every billing interval. The only permitted currency code is USD. */ price: MoneyInput; }; /** Represents app revenue that was captured externally by the partner. */ export type AppRevenueAttributionRecord = Node & { __typename?: 'AppRevenueAttributionRecord'; /** The financial amount captured in this attribution. */ amount: MoneyV2; /** The timestamp when the financial amount was captured. */ capturedAt: Scalars['DateTime']; /** The timestamp at which this revenue attribution was issued. */ createdAt: Scalars['DateTime']; /** Globally unique identifier. */ id: Scalars['ID']; /** * The unique value submitted during the creation of the app revenue attribution record. * For more information, refer to * [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ idempotencyKey: Scalars['String']; /** Indicates whether this is a test submission. */ test: Scalars['Boolean']; /** The type of revenue attribution. */ type: AppRevenueAttributionType; }; /** An auto-generated type for paginating through multiple AppRevenueAttributionRecords. */ export type AppRevenueAttributionRecordConnection = { __typename?: 'AppRevenueAttributionRecordConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `appRevenueAttributionRecordCreate` mutation. */ export type AppRevenueAttributionRecordCreatePayload = { __typename?: 'AppRevenueAttributionRecordCreatePayload'; /** The created app revenue attribution record. */ appRevenueAttributionRecord?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of AppRevenueAttributionRecordCreate. */ export type AppRevenueAttributionRecordCreateUserError = DisplayableError & { __typename?: 'AppRevenueAttributionRecordCreateUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by AppRevenueAttributionRecordCreateUserError. */ export enum AppRevenueAttributionRecordCreateUserErrorCode { /** Input value is invalid. */ Invalid = 'INVALID', /** Input value is already taken. */ Taken = 'TAKEN' } /** Return type for `appRevenueAttributionRecordDelete` mutation. */ export type AppRevenueAttributionRecordDeletePayload = { __typename?: 'AppRevenueAttributionRecordDeletePayload'; /** The revenue attribution that was deleted, if one was. */ deletedId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of AppRevenueAttributionRecordDelete. */ export type AppRevenueAttributionRecordDeleteUserError = DisplayableError & { __typename?: 'AppRevenueAttributionRecordDeleteUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by AppRevenueAttributionRecordDeleteUserError. */ export enum AppRevenueAttributionRecordDeleteUserErrorCode { /** Input value is invalid. */ Invalid = 'INVALID' } /** An auto-generated type which holds one AppRevenueAttributionRecord and a cursor during pagination. */ export type AppRevenueAttributionRecordEdge = { __typename?: 'AppRevenueAttributionRecordEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of AppRevenueAttributionRecordEdge. */ node: AppRevenueAttributionRecord; }; /** Allows to supply an app revenue attribution record. */ export type AppRevenueAttributionRecordInput = { /** * The unique value submitted during creation. * For more information, refer to * [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ idempotencyKey: Scalars['String']; /** The timestamp when the financial amount was captured. */ capturedAt: Scalars['DateTime']; /** The financial amount captured in this attribution. */ amount: MoneyInput; /** The type of revenue attribution. */ type: AppRevenueAttributionType; /** Indicates whether this is a test submission. */ test: Scalars['Boolean']; }; /** The set of valid sort keys for the AppRevenueAttributionRecord query. */ export enum AppRevenueAttributionRecordSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Represents the billing types of revenue attribution. */ export enum AppRevenueAttributionType { /** App purchase related revenue collection. */ ApplicationPurchase = 'APPLICATION_PURCHASE', /** App subscription revenue collection. */ ApplicationSubscription = 'APPLICATION_SUBSCRIPTION', /** App usage-based revenue collection. */ ApplicationUsage = 'APPLICATION_USAGE', /** Other app revenue collection type. */ Other = 'OTHER' } /** Provides users access to services and/or features for a duration of time. */ export type AppSubscription = Node & { __typename?: 'AppSubscription'; /** The date and time when the app subscription was created. */ createdAt: Scalars['DateTime']; /** The date and time when the current app subscription period ends. */ currentPeriodEnd?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** Attaches a plan to an app subscription. */ lineItems: Array; /** The name of the app subscription. */ name: Scalars['String']; /** The URL where the merchant is redirected after approving the app subscription. */ returnUrl: Scalars['URL']; /** * The status of the app subscription. Possible values include pending, active, declined, * expired, frozen, and cancelled. */ status: AppSubscriptionStatus; /** Specifies whether the app subscription is a test transaction. */ test: Scalars['Boolean']; /** The number of days of the free trial. */ trialDays: Scalars['Int']; }; /** Return type for `appSubscriptionCancel` mutation. */ export type AppSubscriptionCancelPayload = { __typename?: 'AppSubscriptionCancelPayload'; /** The cancelled app subscription. */ appSubscription?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple AppSubscriptions. */ export type AppSubscriptionConnection = { __typename?: 'AppSubscriptionConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `appSubscriptionCreate` mutation. */ export type AppSubscriptionCreatePayload = { __typename?: 'AppSubscriptionCreatePayload'; /** The newly created app subscription. */ appSubscription?: Maybe; /** The URL where the merchant approves or declines an app subscription. */ confirmationUrl?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one AppSubscription and a cursor during pagination. */ export type AppSubscriptionEdge = { __typename?: 'AppSubscriptionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of AppSubscriptionEdge. */ node: AppSubscription; }; /** Attaches a plan to an app subscription. */ export type AppSubscriptionLineItem = { __typename?: 'AppSubscriptionLineItem'; /** Globally unique identifier. */ id: Scalars['ID']; /** Defines the pricing model for the app subscription. */ plan: AppPlanV2; /** Lists the store's usage for a usage pricing plan. */ usageRecords: AppUsageRecordConnection; }; /** Attaches a plan to an app subscription. */ export type AppSubscriptionLineItemUsageRecordsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Allows an app to add more than one plan to an app subscription. */ export type AppSubscriptionLineItemInput = { /** Defines the pricing model for the app subscription. */ plan: AppPlanInput; }; /** Return type for `appSubscriptionLineItemUpdate` mutation. */ export type AppSubscriptionLineItemUpdatePayload = { __typename?: 'AppSubscriptionLineItemUpdatePayload'; /** The updated app subscription. */ appSubscription?: Maybe; /** The URL where the merchant approves or declines the updated app subscription line item. */ confirmationUrl?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The set of valid sort keys for the AppSubscription query. */ export enum AppSubscriptionSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The status of the app subscription. */ export enum AppSubscriptionStatus { /** The app subscription is pending approval by the merchant. */ Pending = 'PENDING', /** The app subscription has been approved by the merchant and is ready to be activated by the app. App subscriptions created through the GraphQL Admin API are activated upon approval. */ Accepted = 'ACCEPTED', /** The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions. */ Active = 'ACTIVE', /** The app subscription was declined by the merchant. */ Declined = 'DECLINED', /** The app subscription was not accepted within 2 days of being created. */ Expired = 'EXPIRED', /** The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume. */ Frozen = 'FROZEN', /** The app subscription was cancelled by the app. */ Cancelled = 'CANCELLED' } /** The set of valid sort keys for the AppTransaction query. */ export enum AppTransactionSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Defines the usage pricing model for the app subscription. */ export type AppUsagePricing = { __typename?: 'AppUsagePricing'; /** The total usage records for interval. */ balanceUsed: MoneyV2; /** The limit a store can be charged for usage based pricing. */ cappedAmount: MoneyV2; /** Specifies the interval which usage records are applied. */ interval: AppPricingInterval; /** The terms and conditions for app usage pricing. */ terms: Scalars['String']; }; /** Allows an app to charge a store for usage. */ export type AppUsagePricingInput = { /** The limit a customer can be charged for usage based pricing. */ cappedAmount: MoneyInput; /** The terms and conditions for app usage. */ terms: Scalars['String']; }; /** Store usage for app subscriptions with usage pricing. */ export type AppUsageRecord = Node & { __typename?: 'AppUsageRecord'; /** The date and time when the usage record was created. */ createdAt: Scalars['DateTime']; /** The description of the app usage record. */ description: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The price of the usage record. The only permitted currency code is USD. */ price: MoneyV2; /** Defines the usage pricing plan the merchant is subscribed to. */ subscriptionLineItem: AppSubscriptionLineItem; }; /** An auto-generated type for paginating through multiple AppUsageRecords. */ export type AppUsageRecordConnection = { __typename?: 'AppUsageRecordConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `appUsageRecordCreate` mutation. */ export type AppUsageRecordCreatePayload = { __typename?: 'AppUsageRecordCreatePayload'; /** The newly created app usage record. */ appUsageRecord?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one AppUsageRecord and a cursor during pagination. */ export type AppUsageRecordEdge = { __typename?: 'AppUsageRecordEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of AppUsageRecordEdge. */ node: AppUsageRecord; }; /** The set of valid sort keys for the AppUsageRecord query. */ export enum AppUsageRecordSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Represents a generic custom attribute. */ export type Attribute = { __typename?: 'Attribute'; /** Key or name of the attribute. */ key: Scalars['String']; /** Value of the attribute. */ value?: Maybe; }; /** Specifies the input fields required for an attribute. */ export 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 type AutomaticDiscountApplication = DiscountApplication & { __typename?: 'AutomaticDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** * An ordered index that can be used to identify the discount application and indicate the precedence * of the discount application for calculations. */ index: Scalars['Int']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The title of the discount application. */ title: Scalars['String']; /** The value of the discount application. */ value: PricingValue; }; /** The set of valid sort keys for the AutomaticDiscount query. */ export enum AutomaticDiscountSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** * Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or * the addition of a product. */ export type BasicEvent = Node & Event & { __typename?: 'BasicEvent'; /** The name of the app that created the event. Returns null when the event originates from the Shopify admin. */ appTitle?: Maybe; /** Whether the event was created by an app. */ attributeToApp: Scalars['Boolean']; /** Whether the event was caused by an admin user. */ attributeToUser: Scalars['Boolean']; /** The date and time when the event was created. */ createdAt: Scalars['DateTime']; /** Whether the event is critical. */ criticalAlert: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** Human readable text that describes the event. */ message: Scalars['FormattedString']; }; /** Represents an error that happens during the execution of a billing attempt mutation. */ export type BillingAttemptUserError = DisplayableError & { __typename?: 'BillingAttemptUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by BillingAttemptUserError. */ export enum BillingAttemptUserErrorCode { /** Input value is invalid. */ Invalid = 'INVALID', /** Input value is blank. */ Blank = 'BLANK', /** Subscription contract does not exist. */ ContractNotFound = 'CONTRACT_NOT_FOUND' } /** * An asynchronous long-running operation to fetch data in bulk. * * Bulk operations are created using the `bulkOperationRunQuery` mutation. After they are created, * clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains * a link to the data in [JSONL](http://jsonlines.org/) format. * * See the [bulk operations guide](https://help.shopify.com/api/guides/bulk-operations) for more details. */ export type BulkOperation = Node & { __typename?: 'BulkOperation'; /** When the bulk operation was successfully completed. */ completedAt?: Maybe; /** When the bulk operation was created. */ createdAt: Scalars['DateTime']; /** Error code for failed operations. */ errorCode?: Maybe; /** File size in bytes of the file in the `url` field. */ fileSize?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** * The running count of all objects processed. * For example, when fetching all products and their variants, this field counts both products and variants. * This field can be used to track operation progress. */ objectCount: Scalars['UnsignedInt64']; /** * URL to partial/incomplete response data (in [JSONL](http://jsonlines.org/) format) returned by a failed operation. * Expires **one week** after the operation fails. Returns `null` when there's no data available. */ partialDataUrl?: Maybe; /** GraphQL query document specified in `bulkOperationRunQuery`. */ query: Scalars['String']; /** * The running count of all objects processed at the root of the query. * For example, when fetching all products and their variants, this field counts only products. * This field can be used to track operation progress. */ rootObjectCount: Scalars['UnsignedInt64']; /** Status of the bulk operation. */ status: BulkOperationStatus; /** * URL to the response data in [JSONL](http://jsonlines.org/) format. * Expires **one week** after the operation completes. */ url?: Maybe; }; /** Return type for `bulkOperationCancel` mutation. */ export type BulkOperationCancelPayload = { __typename?: 'BulkOperationCancelPayload'; /** The bulk operation to be canceled. */ bulkOperation?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Error codes for failed bulk operations. */ export enum BulkOperationErrorCode { /** * The provided operation `query` returned access denied due to missing * [access scopes](https://help.shopify.com/api/getting-started/authentication/oauth/scopes). * Review the requested object permissions and execute the query as a normal non-bulk GraphQL request to see more details. */ AccessDenied = 'ACCESS_DENIED', /** Operation resulted in partial or incomplete data due to internal server errors during execution. */ InternalServerError = 'INTERNAL_SERVER_ERROR', /** * Operation resulted in partial or incomplete data due to query timeouts during execution. * In some cases, timeouts can be avoided by modifying your `query` to select fewer fields. */ Timeout = 'TIMEOUT' } /** Return type for `bulkOperationRunQuery` mutation. */ export type BulkOperationRunQueryPayload = { __typename?: 'BulkOperationRunQueryPayload'; /** The newly created bulk operation. */ bulkOperation?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Statuses of a bulk operation. */ export enum BulkOperationStatus { /** Operation created. */ Created = 'CREATED', /** Operation running. */ Running = 'RUNNING', /** Operation completed. */ Completed = 'COMPLETED', /** Operation canceling. */ Canceling = 'CANCELING', /** Operation canceled. */ Canceled = 'CANCELED', /** Operation failed. */ Failed = 'FAILED', /** Operation URL has expired. */ Expired = 'EXPIRED' } /** * Discount code applications capture the intentions of a discount code at * the time that it is applied onto an order. */ export type CalculatedAutomaticDiscountApplication = CalculatedDiscountApplication & { __typename?: 'CalculatedAutomaticDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The level at which the discount was applied. */ appliedTo: DiscountApplicationLevel; /** The description of discount application. Indicates the reason why the discount was applied. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** An amount discounting the line that has been allocated by an associated discount application. */ export type CalculatedDiscountAllocation = { __typename?: 'CalculatedDiscountAllocation'; /** The money amount allocated by the discount application in shop and presentment currencies. */ allocatedAmountSet: MoneyBag; /** The discount that the allocated amount originated from. */ discountApplication: CalculatedDiscountApplication; }; /** A discount application involved in order editing that might be newly added or have new changes applied. */ export type CalculatedDiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The level at which the discount was applied. */ appliedTo: DiscountApplicationLevel; /** The description of discount application. Indicates the reason why the discount was applied. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** An auto-generated type for paginating through multiple CalculatedDiscountApplications. */ export type CalculatedDiscountApplicationConnection = { __typename?: 'CalculatedDiscountApplicationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CalculatedDiscountApplication and a cursor during pagination. */ export type CalculatedDiscountApplicationEdge = { __typename?: 'CalculatedDiscountApplicationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CalculatedDiscountApplicationEdge. */ node: CalculatedDiscountApplication; }; /** * Discount code applications capture the intentions of a discount code at * the time that it is applied onto an order. */ export type CalculatedDiscountCodeApplication = CalculatedDiscountApplication & { __typename?: 'CalculatedDiscountCodeApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The level at which the discount was applied. */ appliedTo: DiscountApplicationLevel; /** The string identifying the discount code that was used at the time of application. */ code: Scalars['String']; /** The description of discount application. Indicates the reason why the discount was applied. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** The computed properties for a draft order. */ export type CalculatedDraftOrder = { __typename?: 'CalculatedDraftOrder'; /** Order-level discount applied to the draft order. */ appliedDiscount?: Maybe; /** The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item. */ availableShippingRates: Array; /** Customer who will be sent an invoice for the draft order, if there is one. */ customer?: Maybe; /** Line items in the draft order with their computed properties. */ lineItems: Array; /** Line item that contains the shipping costs. */ shippingLine?: Maybe; /** Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes). */ subtotalPrice: Scalars['Money']; /** Total amount of taxes charged for each line item and shipping line. */ taxLines: Array; /** Total amount of the draft order (includes taxes, shipping charges, and discounts). */ totalPrice: Scalars['Money']; /** Total shipping charge for the draft order. */ totalShippingPrice: Scalars['Money']; /** Total amount of taxes for the draft order. */ totalTax: Scalars['Money']; }; /** The computed line items for a draft order. */ export type CalculatedDraftOrderLineItem = { __typename?: 'CalculatedDraftOrderLineItem'; /** Discount applied to the line item. */ appliedDiscount?: Maybe; /** Indicates if this is a product variant line item, or a custom line item. */ custom: Scalars['Boolean']; /** List of additional information (metafields) about the line item. */ customAttributes: Array; /** Total price with discounts applied. */ discountedTotal: MoneyV2; /** Unit price with discounts applied. */ discountedUnitPrice: MoneyV2; /** * Name of the service provider who fulfilled the order. * * Valid values are either **manual** or the name of the provider. * For example, **amazon**, **shipwire**. */ fulfillmentService: FulfillmentService; /** Image associated with the draft order line item. */ image?: Maybe; /** Indicates whether the line item represents the puchase of a gift card. */ isGiftCard: Scalars['Boolean']; /** Name of the product. */ name: Scalars['String']; /** Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. */ originalTotal: MoneyV2; /** Variant price without any discounts applied. */ originalUnitPrice: MoneyV2; /** Product associated with the draft order line item. */ product?: Maybe; /** Number of variant items requested in the draft order. */ quantity: Scalars['Int']; /** Whether physical shipping is required for the variant. */ requiresShipping: Scalars['Boolean']; /** Variant SKU number. */ sku?: Maybe; /** Whether the variant is taxable. */ taxable: Scalars['Boolean']; /** Title of the product or variant (this field only applies to custom line items). */ title: Scalars['String']; /** Total value of the discount. */ totalDiscount: MoneyV2; /** Variant associated with the draft order line item. */ variant?: Maybe; /** Name of the variant. */ variantTitle?: Maybe; /** Name of the vendor who made the variant. */ vendor?: Maybe; /** Weight unit and value for a draft order line item. */ weight?: Maybe; }; /** A line item involved in order editing that may be newly added or have new changes applied. */ export type CalculatedLineItem = { __typename?: 'CalculatedLineItem'; /** The discounts that have been allocated onto the line item by discount applications. */ calculatedDiscountAllocations: Array; /** List of additional information (metafields) about the line item. */ customAttributes: Array; /** * The discounts that have been allocated onto the line item by discount applications. * @deprecated Use `calculatedDiscountAllocations` instead */ discountAllocations: Array; /** The total line price after discounts are applied in shop and presentment currencies. */ discountedUnitPriceSet: MoneyBag; /** The total number of items that can be edited. */ editableQuantity: Scalars['Int']; /** The editable quantity prior to any changes made in the current edit. */ editableQuantityBeforeChanges: Scalars['Int']; /** The total price of editable lines in shop and presentment currencies. */ editableSubtotalSet: MoneyBag; /** Whether the calculated line item has a staged discount. */ hasStagedLineItemDiscount: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** The Image object associated to the line item's variant. */ image?: Maybe; /** Variant price without any discounts applied in shop and presentment currencies. */ originalUnitPriceSet: MoneyBag; /** The total number of items. */ quantity: Scalars['Int']; /** Whether the line item can be restocked or not. */ restockable: Scalars['Boolean']; /** Whether the changes on the line item will result in a restock. */ restocking: Scalars['Boolean']; /** Variant SKU number. */ sku?: Maybe; /** A list of changes that affect this line item. */ stagedChanges: Array; /** Title of the product or variant. */ title: Scalars['String']; /** The total price of uneditable lines in shop and presentment currencies. */ uneditableSubtotalSet: MoneyBag; /** * The product variant associated with this line item. Will be null for custom line items and items whose * variant has been deleted. */ variant?: Maybe; /** Name of the variant. */ variantTitle?: Maybe; }; /** An auto-generated type for paginating through multiple CalculatedLineItems. */ export type CalculatedLineItemConnection = { __typename?: 'CalculatedLineItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CalculatedLineItem and a cursor during pagination. */ export type CalculatedLineItemEdge = { __typename?: 'CalculatedLineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CalculatedLineItemEdge. */ node: CalculatedLineItem; }; /** Manual discount applications capture the intentions of a discount that was manually created for an order. */ export type CalculatedManualDiscountApplication = CalculatedDiscountApplication & { __typename?: 'CalculatedManualDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The level at which the discount was applied. */ appliedTo: DiscountApplicationLevel; /** The description of discount application. Indicates the reason why the discount was applied. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** An order with edits applied but not saved. */ export type CalculatedOrder = Node & { __typename?: 'CalculatedOrder'; /** Returns only the new discount applications being added to the order. */ addedDiscountApplications: CalculatedDiscountApplicationConnection; /** Returns only the new line items being added to the order. */ addedLineItems: CalculatedLineItemConnection; /** Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies. */ cartDiscountAmountSet?: Maybe; /** Will be true when the changes have been applied to the order. */ committed: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** * Returns all items on the order that existed before starting the edit. * will include any changes that have been made. */ lineItems: CalculatedLineItemConnection; /** The HTML of the customer notification for the order edit. */ notificationPreviewHtml?: Maybe; /** The customer notification title. */ notificationPreviewTitle: Scalars['String']; /** * The order with changes applied. * @deprecated Use `originalOrder` instead */ order: Order; /** The order without any changes applied. */ originalOrder: Order; /** List of changes made on the order. */ stagedChanges: OrderStagedChangeConnection; /** The sum of the quantities for the line items that contribute to the order's subtotal. */ subtotalLineItemsQuantity: Scalars['Int']; /** Subtotal of the line items and their discounts (does not contain shipping costs, shipping discounts) in shop and presentment currencies. */ subtotalPriceSet?: Maybe; /** Taxes charged for the line item. */ taxLines: Array; /** Total price of the order less the total amount received from the customer in shop and presentment currencies. */ totalOutstandingSet: MoneyBag; /** Total amount of the order (includes taxes and discounts) in shop and presentment currencies. */ totalPriceSet: MoneyBag; }; /** An order with edits applied but not saved. */ export type CalculatedOrderAddedDiscountApplicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order with edits applied but not saved. */ export type CalculatedOrderAddedLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order with edits applied but not saved. */ export type CalculatedOrderLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** An order with edits applied but not saved. */ export type CalculatedOrderStagedChangesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Discount code applications capture the intentions of a discount code at * the time that it is applied onto an order. */ export type CalculatedScriptDiscountApplication = CalculatedDiscountApplication & { __typename?: 'CalculatedScriptDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The level at which the discount was applied. */ appliedTo: DiscountApplicationLevel; /** The description of discount application. Indicates the reason why the discount was applied. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** * A channel represents an app where you sell a group of products and collections. * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */ export type Channel = Node & { __typename?: 'Channel'; /** Underlying app used by the channel. */ app: App; /** The collection publications for the list of collections published to the channel. */ collectionPublicationsV3: ResourcePublicationConnection; /** The list of collections published to the channel. */ collections: CollectionConnection; /** * Unique identifier for the channel. * @deprecated Use `id` instead */ handle: Scalars['String']; /** Whether the collection is available to the channel. */ hasCollection: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** Name of the channel. */ name: Scalars['String']; /** * Menu items for the channel, which also appear as submenu items in left navigation sidebar in the Shopify admin. * @deprecated Use App.navigationItems instead */ navigationItems: Array; /** * Home page for the channel. * @deprecated Use App.launchUrl instead */ overviewPath?: Maybe; /** * The product publications for the products published to the channel. * @deprecated Use `productPublicationsV3` instead */ productPublications: ProductPublicationConnection; /** The product publications for the list of products published to the channel. */ productPublicationsV3: ResourcePublicationConnection; /** The list of products published to the channel. */ products: ProductConnection; /** Whether or not this channel supports future publishing. */ supportsFuturePublishing: Scalars['Boolean']; }; /** * A channel represents an app where you sell a group of products and collections. * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */ export type ChannelCollectionPublicationsV3Args = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * A channel represents an app where you sell a group of products and collections. * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */ export type ChannelCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * A channel represents an app where you sell a group of products and collections. * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */ export type ChannelHasCollectionArgs = { id: Scalars['ID']; }; /** * A channel represents an app where you sell a group of products and collections. * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */ export type ChannelProductPublicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * A channel represents an app where you sell a group of products and collections. * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */ export type ChannelProductPublicationsV3Args = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * A channel represents an app where you sell a group of products and collections. * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */ export type ChannelProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An auto-generated type for paginating through multiple Channels. */ export type ChannelConnection = { __typename?: 'ChannelConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one Channel and a cursor during pagination. */ export type ChannelEdge = { __typename?: 'ChannelEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ChannelEdge. */ node: Channel; }; /** The set of valid sort keys for the CodeDiscount query. */ export enum CodeDiscountSortKeys { /** Sort by the `starts_at` value. */ StartsAt = 'STARTS_AT', /** Sort by the `ends_at` value. */ EndsAt = 'ENDS_AT', /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Represents a collection of products. */ export type Collection = HasMetafields & Node & Publishable & HasPublishedTranslations & { __typename?: 'Collection'; /** The number of publications a resource is published to without feedback errors. */ availablePublicationCount: Scalars['Int']; /** The stripped description of the collection, in a single line with HTML tags removed. */ description: Scalars['String']; /** The description of the collection, complete with HTML formatting. */ descriptionHtml: Scalars['HTML']; /** Information about the collection that's provided through resource feedback. */ feedback?: Maybe; /** A unique human-friendly string for the collection. Automatically generated from the collection's title. */ handle: Scalars['String']; /** Whether the collection includes a product. */ hasProduct: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** The image associated with the collection. */ image?: Maybe; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** The products that are included in the collection. */ products: ProductConnection; /** The number of products included in the collection. */ productsCount: Scalars['Int']; /** The number of publications a resource is published on. */ publicationCount: Scalars['Int']; /** * The channels where the collection is published. * @deprecated Use `resourcePublications` instead */ publications: CollectionPublicationConnection; /** * Check to see whether the resource is published to a given channel. * @deprecated Use `publishedOnPublication` instead */ publishedOnChannel: Scalars['Boolean']; /** * Check to see whether the resource is published to the calling app's channel. * @deprecated Use `publishedOnCurrentPublication` instead */ publishedOnCurrentChannel: Scalars['Boolean']; /** Check to see whether the resource is published to the calling app's publication. */ publishedOnCurrentPublication: Scalars['Boolean']; /** Check to see whether the resource is published to a given publication. */ publishedOnPublication: Scalars['Boolean']; /** The list of resources that are published to a publication. */ resourcePublications: ResourcePublicationConnection; /** The list of resources that are either published or staged to be published to a publication. */ resourcePublicationsV2: ResourcePublicationV2Connection; /** The rules used to assign products to the collection. This applies only to smart collections. */ ruleSet?: Maybe; /** SEO information for the collection. */ seo: Seo; /** The order in which the collection's products are sorted. */ sortOrder: CollectionSortOrder; /** The storefront ID of the collection. */ storefrontId: Scalars['StorefrontID']; /** The theme template used when viewing this collection in a store. */ templateSuffix?: Maybe; /** The title of the collection. */ title: Scalars['String']; /** The translations associated with the resource. */ translations: Array; /** * The list of channels that the resource is not published to. * @deprecated Use `unpublishedPublications` instead */ unpublishedChannels: ChannelConnection; /** The list of publications that the resource is not published to. */ unpublishedPublications: PublicationConnection; /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified. */ updatedAt: Scalars['DateTime']; }; /** Represents a collection of products. */ export type CollectionDescriptionArgs = { truncateAt?: Maybe; }; /** Represents a collection of products. */ export type CollectionHasProductArgs = { id: Scalars['ID']; }; /** Represents a collection of products. */ export type CollectionImageArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Represents a collection of products. */ export type CollectionMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a collection of products. */ export type CollectionMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a collection of products. */ export type CollectionPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a collection of products. */ export type CollectionPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a collection of products. */ export type CollectionProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents a collection of products. */ export type CollectionPublicationCountArgs = { onlyPublished?: Maybe; }; /** Represents a collection of products. */ export type CollectionPublicationsArgs = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a collection of products. */ export type CollectionPublishedOnChannelArgs = { channelId: Scalars['ID']; }; /** Represents a collection of products. */ export type CollectionPublishedOnPublicationArgs = { publicationId: Scalars['ID']; }; /** Represents a collection of products. */ export type CollectionResourcePublicationsArgs = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a collection of products. */ export type CollectionResourcePublicationsV2Args = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a collection of products. */ export type CollectionTranslationsArgs = { locale: Scalars['String']; }; /** Represents a collection of products. */ export type CollectionUnpublishedChannelsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a collection of products. */ export type CollectionUnpublishedPublicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Return type for `collectionAddProducts` mutation. */ export type CollectionAddProductsPayload = { __typename?: 'CollectionAddProductsPayload'; /** The updated collection. */ collection?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple Collections. */ export type CollectionConnection = { __typename?: 'CollectionConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `collectionCreate` mutation. */ export type CollectionCreatePayload = { __typename?: 'CollectionCreatePayload'; /** The collection that has been created. */ collection?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the collection to delete. */ export type CollectionDeleteInput = { /** The ID of the collection to be deleted. */ id: Scalars['ID']; }; /** Return type for `collectionDelete` mutation. */ export type CollectionDeletePayload = { __typename?: 'CollectionDeletePayload'; /** The ID of the collection that was deleted. */ deletedCollectionId?: Maybe; /** The shop associated with the collection. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one Collection and a cursor during pagination. */ export type CollectionEdge = { __typename?: 'CollectionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CollectionEdge. */ node: Collection; }; /** Specifies the input fields required to create a collection. */ export type CollectionInput = { /** The description of the collection, in HTML format. */ descriptionHtml?: Maybe; /** A unique human-friendly string for the collection. Automatically generated from the collection's title. */ handle?: Maybe; /** Specifies the collection to update or create a new collection if absent. */ id?: Maybe; /** The image associated with the collection. */ image?: Maybe; /** Initial list of collection products. Only valid with `productCreate` and without rules. */ products?: Maybe>; /** Initial list of collection publications. Only valid with `productCreate`. This argument is deprecated: Use PublishablePublish instead. */ publications?: Maybe>; /** The private metafields to associated with this product. */ privateMetafields?: Maybe>; /** The rules used to assign products to the collection. */ ruleSet?: Maybe; /** The theme template used when viewing the collection in a store. */ templateSuffix?: Maybe; /** The order in which the collection's products are sorted. */ sortOrder?: Maybe; /** Required for creating a new collection. */ title?: Maybe; /** The metafields to associate with this collection. */ metafields?: Maybe>; /** SEO information for the collection. */ seo?: Maybe; /** * Indicates whether a redirect is required after a new handle has been provided. * If true, then the old handle is redirected to the new one automatically. */ redirectNewHandle?: Maybe; }; /** Represents the publications where a collection is published. */ export type CollectionPublication = { __typename?: 'CollectionPublication'; /** * The channel where the collection will be published. * @deprecated Use `publication` instead */ channel: Channel; /** The collection to be published on the publication. */ collection: Collection; /** Whether the publication is published or not. */ isPublished: Scalars['Boolean']; /** The publication where the collection will be published. */ publication: Publication; /** The date that the publication was or is going to be published. */ publishDate: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple CollectionPublications. */ export type CollectionPublicationConnection = { __typename?: 'CollectionPublicationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CollectionPublication and a cursor during pagination. */ export type CollectionPublicationEdge = { __typename?: 'CollectionPublicationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CollectionPublicationEdge. */ node: CollectionPublication; }; /** Specifies the publications to which a collection will be published. */ export type CollectionPublicationInput = { /** The ID of the publication. */ publicationId?: Maybe; /** The ID of the channel. This argument is deprecated: Use publicationId instead. */ channelId?: Maybe; /** This argument is deprecated: Use publicationId instead. */ channelHandle?: Maybe; }; /** Specifies a collection to publish and the sales channels to publish it to. */ export type CollectionPublishInput = { /** The collection to create or update publications for. */ id: Scalars['ID']; /** The channels where the collection will be published. */ collectionPublications: Array; }; /** Return type for `collectionPublish` mutation. */ export type CollectionPublishPayload = { __typename?: 'CollectionPublishPayload'; /** The published collection. */ collection?: Maybe; /** The channels where the collection has been published. */ collectionPublications?: Maybe>; /** The shop associated with the collection. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `collectionRemoveProducts` mutation. */ export type CollectionRemoveProductsPayload = { __typename?: 'CollectionRemoveProductsPayload'; /** The asynchronous job removing the products. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `collectionReorderProducts` mutation. */ export type CollectionReorderProductsPayload = { __typename?: 'CollectionReorderProductsPayload'; /** The asynchronous job reordering the products. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents at rule that's used to assign products to a collection. */ export type CollectionRule = { __typename?: 'CollectionRule'; /** The attribute that the rule focuses on (for example, `title` or `product_type`). */ column: CollectionRuleColumn; /** The value that the operator is applied to (for example, `Hats`). */ condition: Scalars['String']; /** The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`). */ relation: CollectionRuleRelation; }; /** Specifies the property of a product being used to populate the smart collection. */ export enum CollectionRuleColumn { /** The `tag` attribute. */ Tag = 'TAG', /** The `title` attribute. */ Title = 'TITLE', /** The `type` attribute. */ Type = 'TYPE', /** The `vendor` attribute. */ Vendor = 'VENDOR', /** The `variant_price` attribute. */ VariantPrice = 'VARIANT_PRICE', /** The `is_price_reduced` attribute, a boolean attribute evaluated as `true` if a product has a `compare_at_price` set on any of its variants. */ IsPriceReduced = 'IS_PRICE_REDUCED', /** The `variant_compare_at_price` attribute. */ VariantCompareAtPrice = 'VARIANT_COMPARE_AT_PRICE', /** The `variant_weight` attribute. */ VariantWeight = 'VARIANT_WEIGHT', /** The `variant_inventory` attribute. */ VariantInventory = 'VARIANT_INVENTORY', /** The `variant_title` attribute. */ VariantTitle = 'VARIANT_TITLE' } /** Collections may use rules to automatically include the matching products. This defines restrictions for a type of rule. */ export type CollectionRuleConditions = { __typename?: 'CollectionRuleConditions'; /** Allowed relations of the rule. */ allowedRelations: Array; /** Most commonly used relation for this rule. */ defaultRelation: CollectionRuleRelation; /** Type of the rule. */ ruleType: CollectionRuleColumn; }; /** Specifies a rule to associate with a collection. */ export type CollectionRuleInput = { /** The attribute that the rule focuses on (for example, `title` or `product_type`). */ column: CollectionRuleColumn; /** The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`). */ relation: CollectionRuleRelation; /** The value that the operator is applied to (for example, `Hats`). */ condition: Scalars['String']; }; /** Specifies the relationship between the `column` and the condition. */ export enum CollectionRuleRelation { /** The attribute contains the condition. */ Contains = 'CONTAINS', /** The attribute ends with the condition. */ EndsWith = 'ENDS_WITH', /** The attribute is equal to the condition. */ Equals = 'EQUALS', /** The attribute is greater than the condition. */ GreaterThan = 'GREATER_THAN', /** The attribute is not set. */ IsNotSet = 'IS_NOT_SET', /** The attribute is set. */ IsSet = 'IS_SET', /** The attribute is less than the condition. */ LessThan = 'LESS_THAN', /** The attribute does not contain the condition. */ NotContains = 'NOT_CONTAINS', /** The attribute does not equal the condition. */ NotEquals = 'NOT_EQUALS', /** The attribute starts with the condition. */ StartsWith = 'STARTS_WITH' } /** The set of rules that are used to determine which products are included in the collection. */ export type CollectionRuleSet = { __typename?: 'CollectionRuleSet'; /** * Whether products must match any or all of the rules to be included in the collection. * If true, then products must match one or more of the rules to be included in the collection. * If false, then products must match all of the rules to be included in the collection. */ appliedDisjunctively: Scalars['Boolean']; /** The rules used to assign products to the collection. */ rules: Array; }; /** Specifies a rule set for the collection. */ export type CollectionRuleSetInput = { /** * Whether products must match any or all of the rules to be included in the collection. * If true, then products must match one or more of the rules to be included in the collection. * If false, then products must match all of the rules to be included in the collection. */ appliedDisjunctively: Scalars['Boolean']; /** The rules used to assign products to the collection. */ rules?: Maybe>; }; /** The set of valid sort keys for the Collection query. */ export enum CollectionSortKeys { /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Specifies the sort order for the products in the collection. */ export enum CollectionSortOrder { /** Alphabetically, in ascending order (A - Z). */ AlphaAsc = 'ALPHA_ASC', /** Alphabetically, in descending order (Z - A). */ AlphaDesc = 'ALPHA_DESC', /** By best-selling products. */ BestSelling = 'BEST_SELLING', /** By date created, in ascending order (oldest - newest). */ Created = 'CREATED', /** By date created, in descending order (newest - oldest). */ CreatedDesc = 'CREATED_DESC', /** In the order set manually by the merchant. */ Manual = 'MANUAL', /** By price, in ascending order (lowest - highest). */ PriceAsc = 'PRICE_ASC', /** By price, in descending order (highest - lowest). */ PriceDesc = 'PRICE_DESC' } /** Specifies the collection to unpublish and the sales channels to remove it from. */ export type CollectionUnpublishInput = { /** The collection to create or update publications for. */ id: Scalars['ID']; /** The channels where the collection is published. */ collectionPublications: Array; }; /** Return type for `collectionUnpublish` mutation. */ export type CollectionUnpublishPayload = { __typename?: 'CollectionUnpublishPayload'; /** The collection that has been unpublished. */ collection?: Maybe; /** The shop associated with the collection. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `collectionUpdate` mutation. */ export type CollectionUpdatePayload = { __typename?: 'CollectionUpdatePayload'; /** The updated collection. */ collection?: Maybe; /** The asynchronous job updating the products based on the new rule set. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Comment events are generated by staff members of a shop. * They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer. */ export type CommentEvent = Node & Event & { __typename?: 'CommentEvent'; /** The name of the app that created the event. Returns null when the event originates from the Shopify admin. */ appTitle?: Maybe; /** The attachments associated with the comment event. */ attachments: Array; /** Whether the event was created by an app. */ attributeToApp: Scalars['Boolean']; /** Whether the event was caused by an admin user. */ attributeToUser: Scalars['Boolean']; /** Whether the comment event can be deleted. If true, then the comment event can be deleted. */ canDelete: Scalars['Boolean']; /** Whether the comment event can be edited. If true, then the comment event can be edited. */ canEdit: Scalars['Boolean']; /** The date and time when the event was created. */ createdAt: Scalars['DateTime']; /** Whether the event is critical. */ criticalAlert: Scalars['Boolean']; /** Whether the comment event has been edited. If true, then the comment event has been edited. */ edited: Scalars['Boolean']; /** The references associated with the comment event. */ embed?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** Human readable text that describes the event. */ message: Scalars['FormattedString']; /** The raw body of the comment event. */ rawMessage: Scalars['String']; /** The subject of the comment event. */ subject: CommentEventSubject; }; /** A file attachment associated to a comment event. */ export type CommentEventAttachment = { __typename?: 'CommentEventAttachment'; /** The file extension of the comment event attachment, indicating the file format. */ fileExtension?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The image attached to the comment event. */ image?: Maybe; /** The filename of the comment event attachment. */ name: Scalars['String']; /** The size of the attachment. */ size: Scalars['Int']; /** The URL of the attachment. */ url: Scalars['URL']; }; /** A file attachment associated to a comment event. */ export type CommentEventAttachmentImageArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** The main embed of a comment event. */ export type CommentEventEmbed = Customer | DraftOrder | Order | Product | ProductVariant; /** The subject line of a comment event. */ export type CommentEventSubject = { /** Whether the timeline subject has a timeline comment. If true, then a timeline comment exists. */ hasTimelineComment: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; }; /** Countries that have been defined in shipping zones for the shop. */ export type CountriesInShippingZones = { __typename?: 'CountriesInShippingZones'; /** Countries that have been defined in shipping zones. */ countryCodes: Array; /** Whether 'Rest of World' has been defined in any shipping zones. */ includeRestOfWorld: Scalars['Boolean']; }; /** ISO 3166-1 alpha-2 country codes with some differences. */ export enum CountryCode { /** Afghanistan. */ Af = 'AF', /** Åland Islands. */ Ax = 'AX', /** Albania. */ Al = 'AL', /** Algeria. */ Dz = 'DZ', /** Andorra. */ Ad = 'AD', /** Angola. */ Ao = 'AO', /** Anguilla. */ Ai = 'AI', /** Antigua & Barbuda. */ Ag = 'AG', /** Argentina. */ Ar = 'AR', /** Armenia. */ Am = 'AM', /** Aruba. */ Aw = 'AW', /** Ascension Island. */ Ac = 'AC', /** Australia. */ Au = 'AU', /** Austria. */ At = 'AT', /** Azerbaijan. */ Az = 'AZ', /** Bahamas. */ Bs = 'BS', /** Bahrain. */ Bh = 'BH', /** Bangladesh. */ Bd = 'BD', /** Barbados. */ Bb = 'BB', /** Belarus. */ By = 'BY', /** Belgium. */ Be = 'BE', /** Belize. */ Bz = 'BZ', /** Benin. */ Bj = 'BJ', /** Bermuda. */ Bm = 'BM', /** Bhutan. */ Bt = 'BT', /** Bolivia. */ Bo = 'BO', /** Bosnia & Herzegovina. */ Ba = 'BA', /** Botswana. */ Bw = 'BW', /** Bouvet Island. */ Bv = 'BV', /** Brazil. */ Br = 'BR', /** British Indian Ocean Territory. */ Io = 'IO', /** Brunei. */ Bn = 'BN', /** Bulgaria. */ Bg = 'BG', /** Burkina Faso. */ Bf = 'BF', /** Burundi. */ Bi = 'BI', /** Cambodia. */ Kh = 'KH', /** Canada. */ Ca = 'CA', /** Cape Verde. */ Cv = 'CV', /** Caribbean Netherlands. */ Bq = 'BQ', /** Cayman Islands. */ Ky = 'KY', /** Central African Republic. */ Cf = 'CF', /** Chad. */ Td = 'TD', /** Chile. */ Cl = 'CL', /** China. */ Cn = 'CN', /** Christmas Island. */ Cx = 'CX', /** Cocos (Keeling) Islands. */ Cc = 'CC', /** Colombia. */ Co = 'CO', /** Comoros. */ Km = 'KM', /** Congo - Brazzaville. */ Cg = 'CG', /** Congo - Kinshasa. */ Cd = 'CD', /** Cook Islands. */ Ck = 'CK', /** Costa Rica. */ Cr = 'CR', /** Croatia. */ Hr = 'HR', /** Cuba. */ Cu = 'CU', /** Curaçao. */ Cw = 'CW', /** Cyprus. */ Cy = 'CY', /** Czechia. */ Cz = 'CZ', /** Côte d’Ivoire. */ Ci = 'CI', /** Denmark. */ Dk = 'DK', /** Djibouti. */ Dj = 'DJ', /** Dominica. */ Dm = 'DM', /** Dominican Republic. */ Do = 'DO', /** Ecuador. */ Ec = 'EC', /** Egypt. */ Eg = 'EG', /** El Salvador. */ Sv = 'SV', /** Equatorial Guinea. */ Gq = 'GQ', /** Eritrea. */ Er = 'ER', /** Estonia. */ Ee = 'EE', /** Eswatini. */ Sz = 'SZ', /** Ethiopia. */ Et = 'ET', /** Falkland Islands. */ Fk = 'FK', /** Faroe Islands. */ Fo = 'FO', /** Fiji. */ Fj = 'FJ', /** Finland. */ Fi = 'FI', /** France. */ Fr = 'FR', /** French Guiana. */ Gf = 'GF', /** French Polynesia. */ Pf = 'PF', /** French Southern Territories. */ Tf = 'TF', /** Gabon. */ Ga = 'GA', /** Gambia. */ Gm = 'GM', /** Georgia. */ Ge = 'GE', /** Germany. */ De = 'DE', /** Ghana. */ Gh = 'GH', /** Gibraltar. */ Gi = 'GI', /** Greece. */ Gr = 'GR', /** Greenland. */ Gl = 'GL', /** Grenada. */ Gd = 'GD', /** Guadeloupe. */ Gp = 'GP', /** Guatemala. */ Gt = 'GT', /** Guernsey. */ Gg = 'GG', /** Guinea. */ Gn = 'GN', /** Guinea-Bissau. */ Gw = 'GW', /** Guyana. */ Gy = 'GY', /** Haiti. */ Ht = 'HT', /** Heard & McDonald Islands. */ Hm = 'HM', /** Vatican City. */ Va = 'VA', /** Honduras. */ Hn = 'HN', /** Hong Kong SAR. */ Hk = 'HK', /** Hungary. */ Hu = 'HU', /** Iceland. */ Is = 'IS', /** India. */ In = 'IN', /** Indonesia. */ Id = 'ID', /** Iran. */ Ir = 'IR', /** Iraq. */ Iq = 'IQ', /** Ireland. */ Ie = 'IE', /** Isle of Man. */ Im = 'IM', /** Israel. */ Il = 'IL', /** Italy. */ It = 'IT', /** Jamaica. */ Jm = 'JM', /** Japan. */ Jp = 'JP', /** Jersey. */ Je = 'JE', /** Jordan. */ Jo = 'JO', /** Kazakhstan. */ Kz = 'KZ', /** Kenya. */ Ke = 'KE', /** Kiribati. */ Ki = 'KI', /** North Korea. */ Kp = 'KP', /** Kosovo. */ Xk = 'XK', /** Kuwait. */ Kw = 'KW', /** Kyrgyzstan. */ Kg = 'KG', /** Laos. */ La = 'LA', /** Latvia. */ Lv = 'LV', /** Lebanon. */ Lb = 'LB', /** Lesotho. */ Ls = 'LS', /** Liberia. */ Lr = 'LR', /** Libya. */ Ly = 'LY', /** Liechtenstein. */ Li = 'LI', /** Lithuania. */ Lt = 'LT', /** Luxembourg. */ Lu = 'LU', /** Macao SAR. */ Mo = 'MO', /** Madagascar. */ Mg = 'MG', /** Malawi. */ Mw = 'MW', /** Malaysia. */ My = 'MY', /** Maldives. */ Mv = 'MV', /** Mali. */ Ml = 'ML', /** Malta. */ Mt = 'MT', /** Martinique. */ Mq = 'MQ', /** Mauritania. */ Mr = 'MR', /** Mauritius. */ Mu = 'MU', /** Mayotte. */ Yt = 'YT', /** Mexico. */ Mx = 'MX', /** Moldova. */ Md = 'MD', /** Monaco. */ Mc = 'MC', /** Mongolia. */ Mn = 'MN', /** Montenegro. */ Me = 'ME', /** Montserrat. */ Ms = 'MS', /** Morocco. */ Ma = 'MA', /** Mozambique. */ Mz = 'MZ', /** Myanmar (Burma). */ Mm = 'MM', /** Namibia. */ Na = 'NA', /** Nauru. */ Nr = 'NR', /** Nepal. */ Np = 'NP', /** Netherlands. */ Nl = 'NL', /** Netherlands Antilles. */ An = 'AN', /** New Caledonia. */ Nc = 'NC', /** New Zealand. */ Nz = 'NZ', /** Nicaragua. */ Ni = 'NI', /** Niger. */ Ne = 'NE', /** Nigeria. */ Ng = 'NG', /** Niue. */ Nu = 'NU', /** Norfolk Island. */ Nf = 'NF', /** North Macedonia. */ Mk = 'MK', /** Norway. */ No = 'NO', /** Oman. */ Om = 'OM', /** Pakistan. */ Pk = 'PK', /** Palestinian Territories. */ Ps = 'PS', /** Panama. */ Pa = 'PA', /** Papua New Guinea. */ Pg = 'PG', /** Paraguay. */ Py = 'PY', /** Peru. */ Pe = 'PE', /** Philippines. */ Ph = 'PH', /** Pitcairn Islands. */ Pn = 'PN', /** Poland. */ Pl = 'PL', /** Portugal. */ Pt = 'PT', /** Qatar. */ Qa = 'QA', /** Cameroon. */ Cm = 'CM', /** Réunion. */ Re = 'RE', /** Romania. */ Ro = 'RO', /** Russia. */ Ru = 'RU', /** Rwanda. */ Rw = 'RW', /** St. Barthélemy. */ Bl = 'BL', /** St. Helena. */ Sh = 'SH', /** St. Kitts & Nevis. */ Kn = 'KN', /** St. Lucia. */ Lc = 'LC', /** St. Martin. */ Mf = 'MF', /** St. Pierre & Miquelon. */ Pm = 'PM', /** Samoa. */ Ws = 'WS', /** San Marino. */ Sm = 'SM', /** São Tomé & Príncipe. */ St = 'ST', /** Saudi Arabia. */ Sa = 'SA', /** Senegal. */ Sn = 'SN', /** Serbia. */ Rs = 'RS', /** Seychelles. */ Sc = 'SC', /** Sierra Leone. */ Sl = 'SL', /** Singapore. */ Sg = 'SG', /** Sint Maarten. */ Sx = 'SX', /** Slovakia. */ Sk = 'SK', /** Slovenia. */ Si = 'SI', /** Solomon Islands. */ Sb = 'SB', /** Somalia. */ So = 'SO', /** South Africa. */ Za = 'ZA', /** South Georgia & South Sandwich Islands. */ Gs = 'GS', /** South Korea. */ Kr = 'KR', /** South Sudan. */ Ss = 'SS', /** Spain. */ Es = 'ES', /** Sri Lanka. */ Lk = 'LK', /** St. Vincent & Grenadines. */ Vc = 'VC', /** Sudan. */ Sd = 'SD', /** Suriname. */ Sr = 'SR', /** Svalbard & Jan Mayen. */ Sj = 'SJ', /** Sweden. */ Se = 'SE', /** Switzerland. */ Ch = 'CH', /** Syria. */ Sy = 'SY', /** Taiwan. */ Tw = 'TW', /** Tajikistan. */ Tj = 'TJ', /** Tanzania. */ Tz = 'TZ', /** Thailand. */ Th = 'TH', /** Timor-Leste. */ Tl = 'TL', /** Togo. */ Tg = 'TG', /** Tokelau. */ Tk = 'TK', /** Tonga. */ To = 'TO', /** Trinidad & Tobago. */ Tt = 'TT', /** Tristan da Cunha. */ Ta = 'TA', /** Tunisia. */ Tn = 'TN', /** Turkey. */ Tr = 'TR', /** Turkmenistan. */ Tm = 'TM', /** Turks & Caicos Islands. */ Tc = 'TC', /** Tuvalu. */ Tv = 'TV', /** Uganda. */ Ug = 'UG', /** Ukraine. */ Ua = 'UA', /** United Arab Emirates. */ Ae = 'AE', /** United Kingdom. */ Gb = 'GB', /** United States. */ Us = 'US', /** U.S. Outlying Islands. */ Um = 'UM', /** Uruguay. */ Uy = 'UY', /** Uzbekistan. */ Uz = 'UZ', /** Vanuatu. */ Vu = 'VU', /** Venezuela. */ Ve = 'VE', /** Vietnam. */ Vn = 'VN', /** British Virgin Islands. */ Vg = 'VG', /** Wallis & Futuna. */ Wf = 'WF', /** Western Sahara. */ Eh = 'EH', /** Yemen. */ Ye = 'YE', /** Zambia. */ Zm = 'ZM', /** Zimbabwe. */ Zw = 'ZW', /** Unknown Region. */ Zz = 'ZZ' } /** Holds the country specific harmonized system code and the country ISO code. */ export type CountryHarmonizedSystemCode = { __typename?: 'CountryHarmonizedSystemCode'; /** Country ISO code. */ countryCode: CountryCode; /** Country specific harmonized system code. */ harmonizedSystemCode: Scalars['String']; }; /** An auto-generated type for paginating through multiple CountryHarmonizedSystemCodes. */ export type CountryHarmonizedSystemCodeConnection = { __typename?: 'CountryHarmonizedSystemCodeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CountryHarmonizedSystemCode and a cursor during pagination. */ export type CountryHarmonizedSystemCodeEdge = { __typename?: 'CountryHarmonizedSystemCodeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CountryHarmonizedSystemCodeEdge. */ node: CountryHarmonizedSystemCode; }; /** Holds the country specific harmonized system code and the country ISO code. */ export type CountryHarmonizedSystemCodeInput = { /** Country specific harmonized system code. */ harmonizedSystemCode: Scalars['String']; /** Country ISO code. */ countryCode: CountryCode; }; /** Specifies the input fields required to create a media object. */ export type CreateMediaInput = { /** The original source of the media object. May be an external URL or signed upload URL. */ originalSource: Scalars['String']; /** The alt text associated to the media. */ alt?: Maybe; /** The media content type. */ mediaContentType: MediaContentType; }; /** The part of the image that should remain after cropping. */ export enum CropRegion { /** Keep the center of the image. */ Center = 'CENTER', /** Keep the top of the image. */ Top = 'TOP', /** Keep the bottom of the image. */ Bottom = 'BOTTOM', /** Keep the left of the image. */ Left = 'LEFT', /** Keep the right of the image. */ Right = 'RIGHT' } /** Currency codes. */ export enum CurrencyCode { /** United States Dollars (USD). */ Usd = 'USD', /** Euro (EUR). */ Eur = 'EUR', /** United Kingdom Pounds (GBP). */ Gbp = 'GBP', /** Canadian Dollars (CAD). */ Cad = 'CAD', /** Afghan Afghani (AFN). */ Afn = 'AFN', /** Albanian Lek (ALL). */ All = 'ALL', /** Algerian Dinar (DZD). */ Dzd = 'DZD', /** Angolan Kwanza (AOA). */ Aoa = 'AOA', /** Argentine Pesos (ARS). */ Ars = 'ARS', /** Armenian Dram (AMD). */ Amd = 'AMD', /** Aruban Florin (AWG). */ Awg = 'AWG', /** Australian Dollars (AUD). */ Aud = 'AUD', /** Barbadian Dollar (BBD). */ Bbd = 'BBD', /** Azerbaijani Manat (AZN). */ Azn = 'AZN', /** Bangladesh Taka (BDT). */ Bdt = 'BDT', /** Bahamian Dollar (BSD). */ Bsd = 'BSD', /** Bahraini Dinar (BHD). */ Bhd = 'BHD', /** Burundian Franc (BIF). */ Bif = 'BIF', /** Belize Dollar (BZD). */ Bzd = 'BZD', /** Bermudian Dollar (BMD). */ Bmd = 'BMD', /** Bhutanese Ngultrum (BTN). */ Btn = 'BTN', /** Bosnia and Herzegovina Convertible Mark (BAM). */ Bam = 'BAM', /** Brazilian Real (BRL). */ Brl = 'BRL', /** Bolivian Boliviano (BOB). */ Bob = 'BOB', /** Botswana Pula (BWP). */ Bwp = 'BWP', /** Brunei Dollar (BND). */ Bnd = 'BND', /** Bulgarian Lev (BGN). */ Bgn = 'BGN', /** Burmese Kyat (MMK). */ Mmk = 'MMK', /** Cambodian Riel. */ Khr = 'KHR', /** Cape Verdean escudo (CVE). */ Cve = 'CVE', /** Cayman Dollars (KYD). */ Kyd = 'KYD', /** Central African CFA Franc (XAF). */ Xaf = 'XAF', /** Chilean Peso (CLP). */ Clp = 'CLP', /** Chinese Yuan Renminbi (CNY). */ Cny = 'CNY', /** Colombian Peso (COP). */ Cop = 'COP', /** Comorian Franc (KMF). */ Kmf = 'KMF', /** Congolese franc (CDF). */ Cdf = 'CDF', /** Costa Rican Colones (CRC). */ Crc = 'CRC', /** Croatian Kuna (HRK). */ Hrk = 'HRK', /** Czech Koruny (CZK). */ Czk = 'CZK', /** Danish Kroner (DKK). */ Dkk = 'DKK', /** Dominican Peso (DOP). */ Dop = 'DOP', /** East Caribbean Dollar (XCD). */ Xcd = 'XCD', /** Egyptian Pound (EGP). */ Egp = 'EGP', /** Ethiopian Birr (ETB). */ Etb = 'ETB', /** CFP Franc (XPF). */ Xpf = 'XPF', /** Fijian Dollars (FJD). */ Fjd = 'FJD', /** Gambian Dalasi (GMD). */ Gmd = 'GMD', /** Ghanaian Cedi (GHS). */ Ghs = 'GHS', /** Guatemalan Quetzal (GTQ). */ Gtq = 'GTQ', /** Guyanese Dollar (GYD). */ Gyd = 'GYD', /** Georgian Lari (GEL). */ Gel = 'GEL', /** Haitian Gourde (HTG). */ Htg = 'HTG', /** Honduran Lempira (HNL). */ Hnl = 'HNL', /** Hong Kong Dollars (HKD). */ Hkd = 'HKD', /** Hungarian Forint (HUF). */ Huf = 'HUF', /** Icelandic Kronur (ISK). */ Isk = 'ISK', /** Indian Rupees (INR). */ Inr = 'INR', /** Indonesian Rupiah (IDR). */ Idr = 'IDR', /** Israeli New Shekel (NIS). */ Ils = 'ILS', /** Iraqi Dinar (IQD). */ Iqd = 'IQD', /** Jamaican Dollars (JMD). */ Jmd = 'JMD', /** Japanese Yen (JPY). */ Jpy = 'JPY', /** Jersey Pound. */ Jep = 'JEP', /** Jordanian Dinar (JOD). */ Jod = 'JOD', /** Kazakhstani Tenge (KZT). */ Kzt = 'KZT', /** Kenyan Shilling (KES). */ Kes = 'KES', /** Kuwaiti Dinar (KWD). */ Kwd = 'KWD', /** Kyrgyzstani Som (KGS). */ Kgs = 'KGS', /** Laotian Kip (LAK). */ Lak = 'LAK', /** Latvian Lati (LVL). */ Lvl = 'LVL', /** Lebanese Pounds (LBP). */ Lbp = 'LBP', /** Lesotho Loti (LSL). */ Lsl = 'LSL', /** Liberian Dollar (LRD). */ Lrd = 'LRD', /** Lithuanian Litai (LTL). */ Ltl = 'LTL', /** Malagasy Ariary (MGA). */ Mga = 'MGA', /** Macedonia Denar (MKD). */ Mkd = 'MKD', /** Macanese Pataca (MOP). */ Mop = 'MOP', /** Malawian Kwacha (MWK). */ Mwk = 'MWK', /** Maldivian Rufiyaa (MVR). */ Mvr = 'MVR', /** Mexican Pesos (MXN). */ Mxn = 'MXN', /** Malaysian Ringgits (MYR). */ Myr = 'MYR', /** Mauritian Rupee (MUR). */ Mur = 'MUR', /** Moldovan Leu (MDL). */ Mdl = 'MDL', /** Moroccan Dirham. */ Mad = 'MAD', /** Mongolian Tugrik. */ Mnt = 'MNT', /** Mozambican Metical. */ Mzn = 'MZN', /** Namibian Dollar. */ Nad = 'NAD', /** Nepalese Rupee (NPR). */ Npr = 'NPR', /** Netherlands Antillean Guilder. */ Ang = 'ANG', /** New Zealand Dollars (NZD). */ Nzd = 'NZD', /** Nicaraguan Córdoba (NIO). */ Nio = 'NIO', /** Nigerian Naira (NGN). */ Ngn = 'NGN', /** Norwegian Kroner (NOK). */ Nok = 'NOK', /** Omani Rial (OMR). */ Omr = 'OMR', /** Panamian Balboa (PAB). */ Pab = 'PAB', /** Pakistani Rupee (PKR). */ Pkr = 'PKR', /** Papua New Guinean Kina (PGK). */ Pgk = 'PGK', /** Paraguayan Guarani (PYG). */ Pyg = 'PYG', /** Peruvian Nuevo Sol (PEN). */ Pen = 'PEN', /** Philippine Peso (PHP). */ Php = 'PHP', /** Polish Zlotych (PLN). */ Pln = 'PLN', /** Qatari Rial (QAR). */ Qar = 'QAR', /** Romanian Lei (RON). */ Ron = 'RON', /** Russian Rubles (RUB). */ Rub = 'RUB', /** Rwandan Franc (RWF). */ Rwf = 'RWF', /** Samoan Tala (WST). */ Wst = 'WST', /** Saudi Riyal (SAR). */ Sar = 'SAR', /** Sao Tome And Principe Dobra (STD). */ Std = 'STD', /** Serbian dinar (RSD). */ Rsd = 'RSD', /** Seychellois Rupee (SCR). */ Scr = 'SCR', /** Singapore Dollars (SGD). */ Sgd = 'SGD', /** Sudanese Pound (SDG). */ Sdg = 'SDG', /** Syrian Pound (SYP). */ Syp = 'SYP', /** South African Rand (ZAR). */ Zar = 'ZAR', /** South Korean Won (KRW). */ Krw = 'KRW', /** South Sudanese Pound (SSP). */ Ssp = 'SSP', /** Solomon Islands Dollar (SBD). */ Sbd = 'SBD', /** Sri Lankan Rupees (LKR). */ Lkr = 'LKR', /** Surinamese Dollar (SRD). */ Srd = 'SRD', /** Swazi Lilangeni (SZL). */ Szl = 'SZL', /** Swedish Kronor (SEK). */ Sek = 'SEK', /** Swiss Francs (CHF). */ Chf = 'CHF', /** Taiwan Dollars (TWD). */ Twd = 'TWD', /** Thai baht (THB). */ Thb = 'THB', /** Tanzanian Shilling (TZS). */ Tzs = 'TZS', /** Trinidad and Tobago Dollars (TTD). */ Ttd = 'TTD', /** Tunisian Dinar (TND). */ Tnd = 'TND', /** Turkish Lira (TRY). */ Try = 'TRY', /** Turkmenistani Manat (TMT). */ Tmt = 'TMT', /** Ugandan Shilling (UGX). */ Ugx = 'UGX', /** Ukrainian Hryvnia (UAH). */ Uah = 'UAH', /** United Arab Emirates Dirham (AED). */ Aed = 'AED', /** Uruguayan Pesos (UYU). */ Uyu = 'UYU', /** Uzbekistan som (UZS). */ Uzs = 'UZS', /** Vanuatu Vatu (VUV). */ Vuv = 'VUV', /** Vietnamese đồng (VND). */ Vnd = 'VND', /** West African CFA franc (XOF). */ Xof = 'XOF', /** Yemeni Rial (YER). */ Yer = 'YER', /** Zambian Kwacha (ZMW). */ Zmw = 'ZMW', /** Belarusian Ruble (BYN). */ Byn = 'BYN', /** Belarusian Ruble (BYR). */ Byr = 'BYR', /** Djiboutian Franc (DJF). */ Djf = 'DJF', /** Eritrean Nakfa (ERN). */ Ern = 'ERN', /** Falkland Islands Pounds (FKP). */ Fkp = 'FKP', /** Gibraltar Pounds (GIP). */ Gip = 'GIP', /** Guinean Franc (GNF). */ Gnf = 'GNF', /** Iranian Rial (IRR). */ Irr = 'IRR', /** Kiribati Dollar (KID). */ Kid = 'KID', /** Libyan Dinar (LYD). */ Lyd = 'LYD', /** Mauritanian Ouguiya (MRU). */ Mru = 'MRU', /** Sierra Leonean Leone (SLL). */ Sll = 'SLL', /** Saint Helena Pounds (SHP). */ Shp = 'SHP', /** Somali Shilling (SOS). */ Sos = 'SOS', /** Tajikistani Somoni (TJS). */ Tjs = 'TJS', /** Tongan Pa'anga (TOP). */ Top = 'TOP', /** Venezuelan Bolivares (VEF). */ Vef = 'VEF', /** Venezuelan Bolivares (VES). */ Ves = 'VES' } /** Currency formats. */ export type CurrencyFormats = { __typename?: 'CurrencyFormats'; /** HTML without currency. */ moneyFormat: Scalars['FormattedString']; /** Email without currency. */ moneyInEmailsFormat: Scalars['String']; /** HTML with currency. */ moneyWithCurrencyFormat: Scalars['FormattedString']; /** Email with currency. */ moneyWithCurrencyInEmailsFormat: Scalars['String']; }; /** Represents a currency setting. */ export type CurrencySetting = { __typename?: 'CurrencySetting'; /** The currency's ISO code. */ currencyCode: CurrencyCode; /** The full name of the currency. */ currencyName: Scalars['String']; /** Flag describing whether the currency is enabled. */ enabled: Scalars['Boolean']; /** Date and time when the exchange rate for the currency was last modified. */ rateUpdatedAt?: Maybe; }; /** An auto-generated type for paginating through multiple CurrencySettings. */ export type CurrencySettingConnection = { __typename?: 'CurrencySettingConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CurrencySetting and a cursor during pagination. */ export type CurrencySettingEdge = { __typename?: 'CurrencySettingEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CurrencySettingEdge. */ node: CurrencySetting; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type Customer = Node & CommentEventSubject & HasMetafields & LegacyInteroperability & HasEvents & { __typename?: 'Customer'; /** Whether the customer has agreed to receive marketing materials. */ acceptsMarketing: Scalars['Boolean']; /** The date and time when the customer consented or objected to receiving marketing material by email. */ acceptsMarketingUpdatedAt: Scalars['DateTime']; /** A list of addresses associated with the customer. */ addresses: Array; /** * The average amount that the customer spent per order. * @deprecated Use `averageOrderAmountV2` instead */ averageOrderAmount?: Maybe; /** The average amount that the customer spent per order. */ averageOrderAmountV2?: Maybe; /** * Whether the merchant can delete the customer from their store. * * A customer can be deleted from a store only if they have not yet made an order. After a customer makes an * order, they can't be deleted from a store. */ canDelete: Scalars['Boolean']; /** The date and time when the customer was added to the store. */ createdAt: Scalars['DateTime']; /** The default address associated with the customer. */ defaultAddress?: Maybe; /** * The full name of the customer, based on the values for first_name and last_name. If the first_name and * last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. */ displayName: Scalars['String']; /** The customer's email address. */ email?: Maybe; /** A list of events associated with the customer. */ events: EventConnection; /** The customer's first name. */ firstName?: Maybe; /** Whether the customer has a note associated with them. */ hasNote: Scalars['Boolean']; /** Whether the merchant has added timeline comments about the customer on the customer's page. */ hasTimelineComment: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** The image associated with the customer. */ image: Image; /** The customer's last name. */ lastName?: Maybe; /** The customer's last order. */ lastOrder?: Maybe; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** * The amount of time since the customer was first added to the store. * * Example: 'about 12 years'. */ lifetimeDuration: Scalars['String']; /** The customer's locale. */ locale: Scalars['String']; /** * The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the * customer gave when they consented to receive marketing material by email. * * If the customer does not accept email marketing, then this property will be null. */ marketingOptInLevel?: Maybe; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** A unique identifier for the customer that's used with Multipass login. */ multipassIdentifier?: Maybe; /** A note about the customer. */ note?: Maybe; /** A list of the customer's orders. */ orders: OrderConnection; /** The number of orders that the customer has made at the store in their lifetime. */ ordersCount: Scalars['UnsignedInt64']; /** A list of the customer's payment methods. */ paymentMethods: CustomerPaymentMethodConnection; /** The customer's phone number. */ phone?: Maybe; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** Possible subscriber states of a customer defined by their subscription contracts. */ productSubscriberStatus: CustomerProductSubscriberStatus; /** The state of the customer's account with the shop. */ state: CustomerState; /** A list of the customer's subscription contracts. */ subscriptionContracts: SubscriptionContractConnection; /** A comma separated list of tags that have been added to the customer. */ tags: Array; /** Whether the customer is exempt from being charged taxes on their orders. */ taxExempt: Scalars['Boolean']; /** The list of tax exemptions applied to the customer. */ taxExemptions: Array; /** The total amount that the customer has spent on orders in their lifetime. */ totalSpent: Scalars['Money']; /** The total amount that the customer has spent on orders in their lifetime. */ totalSpentV2: MoneyV2; /** The date and time when the customer was last updated. */ updatedAt: Scalars['DateTime']; /** * Whether the email address is formatted correctly. This does not * guarantee that the email address actually exists. */ validEmailAddress: Scalars['Boolean']; /** Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API. */ verifiedEmail: Scalars['Boolean']; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerAddressesArgs = { first?: Maybe; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerImageArgs = { size?: Maybe; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerOrdersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerPaymentMethodsArgs = { showRevoked?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents information about a customer of the shop, such as the customer's contact details, their order * history, and whether they've agreed to receive email marketing. */ export type CustomerSubscriptionContractsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Return type for `customerAddTaxExemptions` mutation. */ export type CustomerAddTaxExemptionsPayload = { __typename?: 'CustomerAddTaxExemptionsPayload'; /** The updated customer. */ customer?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple Customers. */ export type CustomerConnection = { __typename?: 'CustomerConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `customerCreate` mutation. */ export type CustomerCreatePayload = { __typename?: 'CustomerCreatePayload'; /** The created customer. */ customer?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a card instrument for customer payment method. */ export type CustomerCreditCard = { __typename?: 'CustomerCreditCard'; /** The billing address of the card. */ billingAddress?: Maybe; /** The brand of the card. */ brand: Scalars['String']; /** Whether the card is about to expire. */ expiresSoon: Scalars['Boolean']; /** The expiry month of the card. */ expiryMonth: Scalars['Int']; /** The expiry year of the card. */ expiryYear: Scalars['Int']; /** The card's BIN number. */ firstDigits?: Maybe; /** The payment method can be revoked if there are no active subscription contracts. */ isRevocable: Scalars['Boolean']; /** The last 4 digits of the card. */ lastDigits: Scalars['String']; /** The masked card number with only the last 4 digits displayed. */ maskedNumber: Scalars['String']; /** The name of the card holder. */ name: Scalars['String']; }; /** The billing address of a credit card payment instrument. */ export type CustomerCreditCardBillingAddress = { __typename?: 'CustomerCreditCardBillingAddress'; /** The first line of the address. Typically the street address or PO Box number. */ address1?: Maybe; /** The name of the city, district, village, or town. */ city?: Maybe; /** The name of the country. */ country?: Maybe; /** * The two-letter code for the country of the address. * For example, US. */ countryCode?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** * The two-letter code for the region. * For example, ON. */ provinceCode?: Maybe; /** The zip or postal code of the address. */ zip?: Maybe; }; /** Specifies the customer to delete. */ export type CustomerDeleteInput = { /** The ID of the customer to delete. */ id: Scalars['ID']; }; /** Return type for `customerDelete` mutation. */ export type CustomerDeletePayload = { __typename?: 'CustomerDeletePayload'; /** ID of the deleted customer. */ deletedCustomerId?: Maybe; /** Shop of the deleted customer. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one Customer and a cursor during pagination. */ export type CustomerEdge = { __typename?: 'CustomerEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CustomerEdge. */ node: Customer; }; /** Return type for `customerGenerateAccountActivationUrl` mutation. */ export type CustomerGenerateAccountActivationUrlPayload = { __typename?: 'CustomerGenerateAccountActivationUrlPayload'; /** The newly generated account activation URL. */ accountActivationUrl?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Provides the fields and values to use when creating or updating a customer. */ export type CustomerInput = { /** Whether the customer has consented to receive marketing material via email. */ acceptsMarketing?: Maybe; /** * The date and time when the customer consented or objected to receiving marketing material by email. Set * whenever the customer consents or objects to marketing material. */ acceptsMarketingUpdatedAt?: Maybe; /** An input that specifies addresses for a customer. */ addresses?: Maybe>; /** The unique email address of the customer. */ email?: Maybe; /** The customer's first name. */ firstName?: Maybe; /** Specifies the customer to update, or creates a new customer if one doesn't exist. */ id?: Maybe; /** The customer's last name. */ lastName?: Maybe; /** The customer's locale. */ locale?: Maybe; /** * The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that was * enabled when the customer consented to receiving marketing material by email. */ marketingOptInLevel?: Maybe; /** Attaches additional metadata to the customer. */ metafields?: Maybe>; /** A note about the customer. */ note?: Maybe; /** The unique phone number for the customer. */ phone?: Maybe; /** The private metafields to associated with this product. */ privateMetafields?: Maybe>; /** * A comma separated list of tags associated with the customer. Updating `tags` overwrites * any existing tags that were previously added to the customer. To add new tags without overwriting * existing tags, use the [tagsAdd](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/tagsadd) * mutation. */ tags?: Maybe>; /** Whether the customer is exempt from paying taxes on their order. */ taxExempt?: Maybe; /** The list of tax exemptions to apply to the customer. */ taxExemptions?: Maybe>; }; /** Represents a customer's activity on a shop's online store. */ export type CustomerJourney = { __typename?: 'CustomerJourney'; /** The position of the current order within the customer's order history. */ customerOrderIndex: Scalars['Int']; /** The amount of days between first session and order creation date. First session represents first session since the last order, or first session within the 30 day attribution window, if more than 30 days has passed since the last order. */ daysToConversion: Scalars['Int']; /** The customer's first session going into the shop. */ firstVisit: CustomerVisit; /** The last session before an order is made. */ lastVisit?: Maybe; /** Events preceding a customer order, such as shop sessions. */ moments: Array; }; /** Represents a customer's activity on a shop's online store. */ export type CustomerJourneySummary = { __typename?: 'CustomerJourneySummary'; /** The position of the current order within the customer's order history. Test orders aren't included. */ customerOrderIndex?: Maybe; /** The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order. */ daysToConversion?: Maybe; /** The customer's first session going into the shop. */ firstVisit?: Maybe; /** The last session before an order is made. */ lastVisit?: Maybe; /** The events preceding a customer order, such as shop sessions. */ moments?: Maybe; /** The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed. */ momentsCount?: Maybe; /** Whether or not the attributed sessions for the order have been created yet. */ ready: Scalars['Boolean']; }; /** Represents a customer's activity on a shop's online store. */ export type CustomerJourneySummaryMomentsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * The valid values for the marketing subscription opt-in active at the time the customer consented to email * marketing. * * The levels are defined by [the M3AAWG best practices guideline * document](https://www.m3aawg.org/sites/maawg/files/news/M3AAWG_Senders_BCP_Ver3-2015-02.pdf). */ export enum CustomerMarketingOptInLevel { /** * The customer started receiving marketing email(s) after providing their email address, without any * intermediate steps. */ SingleOptIn = 'SINGLE_OPT_IN', /** * After providing their email address, the customer received a confirmation email which required them to * perform a prescribed action before receiving marketing emails. */ ConfirmedOptIn = 'CONFIRMED_OPT_IN', /** The customer receives marketing emails, but the original opt-in process is unknown. */ Unknown = 'UNKNOWN' } /** Represents events preceding a customer order, such as shop sessions. */ export type CustomerMoment = { /** When the customer moment occurred. */ occurredAt: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple CustomerMoments. */ export type CustomerMomentConnection = { __typename?: 'CustomerMomentConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CustomerMoment and a cursor during pagination. */ export type CustomerMomentEdge = { __typename?: 'CustomerMomentEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CustomerMomentEdge. */ node: CustomerMoment; }; /** All possible instruments for CustomerPaymentMethods. */ export type CustomerPaymentInstrument = CustomerCreditCard; /** A customer's payment method. */ export type CustomerPaymentMethod = Node & { __typename?: 'CustomerPaymentMethod'; /** The customer to whom the payment method belongs. */ customer?: Maybe; /** The ID of this payment method. */ id: Scalars['ID']; /** The instrument for this payment method. */ instrument?: Maybe; /** The time that the payment method was revoked. */ revokedAt?: Maybe; /** List Subscription Contracts. */ subscriptionContracts: SubscriptionContractConnection; }; /** A customer's payment method. */ export type CustomerPaymentMethodSubscriptionContractsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An auto-generated type for paginating through multiple CustomerPaymentMethods. */ export type CustomerPaymentMethodConnection = { __typename?: 'CustomerPaymentMethodConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `customerPaymentMethodCreditCardCreate` mutation. */ export type CustomerPaymentMethodCreditCardCreatePayload = { __typename?: 'CustomerPaymentMethodCreditCardCreatePayload'; /** The customer payment method. */ customerPaymentMethod?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `customerPaymentMethodCreditCardUpdate` mutation. */ export type CustomerPaymentMethodCreditCardUpdatePayload = { __typename?: 'CustomerPaymentMethodCreditCardUpdatePayload'; /** The customer payment method. */ customerPaymentMethod?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination. */ export type CustomerPaymentMethodEdge = { __typename?: 'CustomerPaymentMethodEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of CustomerPaymentMethodEdge. */ node: CustomerPaymentMethod; }; /** Return type for `customerPaymentMethodRemoteCreditCardCreate` mutation. */ export type CustomerPaymentMethodRemoteCreditCardCreatePayload = { __typename?: 'CustomerPaymentMethodRemoteCreditCardCreatePayload'; /** The customer payment method. */ customerPaymentMethod?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `customerPaymentMethodRevoke` mutation. */ export type CustomerPaymentMethodRevokePayload = { __typename?: 'CustomerPaymentMethodRevokePayload'; /** The ID of the revoked customer payment method. */ revokedCustomerPaymentMethodId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `customerPaymentMethodSendUpdateEmail` mutation. */ export type CustomerPaymentMethodSendUpdateEmailPayload = { __typename?: 'CustomerPaymentMethodSendUpdateEmailPayload'; /** The customer to whom an update payment method email was sent. */ customer?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents an error in the input of a mutation. */ export type CustomerPaymentMethodUserError = DisplayableError & { __typename?: 'CustomerPaymentMethodUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by CustomerPaymentMethodUserError. */ export enum CustomerPaymentMethodUserErrorCode { /** Input value is invalid. */ Invalid = 'INVALID', /** Input value is not present. */ Present = 'PRESENT', /** Input value is already taken. */ Taken = 'TAKEN' } /** Possible subscriber states of a customer defined by their subscription contracts. */ export enum CustomerProductSubscriberStatus { /** The customer has at least one active subscription contract. */ Active = 'ACTIVE', /** * The customer's last subscription contract was cancelled and there are no other active or paused * subscription contracts. */ Cancelled = 'CANCELLED', /** * The customer's last subscription contract expired and there are no other active or paused * subscription contracts. */ Expired = 'EXPIRED', /** * The customer's last subscription contract failed and there are no other active or paused * subscription contracts. */ Failed = 'FAILED', /** The customer has never had a subscription contract. */ NeverSubscribed = 'NEVER_SUBSCRIBED', /** * The customer has at least one paused subscription contract and there are no other active * subscription contracts. */ Paused = 'PAUSED' } /** Return type for `customerRemoveTaxExemptions` mutation. */ export type CustomerRemoveTaxExemptionsPayload = { __typename?: 'CustomerRemoveTaxExemptionsPayload'; /** The updated customer. */ customer?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `customerReplaceTaxExemptions` mutation. */ export type CustomerReplaceTaxExemptionsPayload = { __typename?: 'CustomerReplaceTaxExemptionsPayload'; /** The updated customer. */ customer?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The set of valid sort keys for the CustomerSavedSearch query. */ export enum CustomerSavedSearchSortKeys { /** Sort by the `name` value. */ Name = 'NAME', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The set of valid sort keys for the Customer query. */ export enum CustomerSortKeys { /** Sort by the `name` value. */ Name = 'NAME', /** Sort by the `location` value. */ Location = 'LOCATION', /** Sort by the `orders_count` value. */ OrdersCount = 'ORDERS_COUNT', /** Sort by the `last_order_date` value. */ LastOrderDate = 'LAST_ORDER_DATE', /** Sort by the `total_spent` value. */ TotalSpent = 'TOTAL_SPENT', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The valid values for the state of a customer's account with a shop. */ export enum CustomerState { /** The customer declined the email invite to create an account. */ Declined = 'DECLINED', /** The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time. */ Disabled = 'DISABLED', /** The customer has created an account. */ Enabled = 'ENABLED', /** The customer has received an email invite to create an account. */ Invited = 'INVITED' } /** Return type for `customerUpdateDefaultAddress` mutation. */ export type CustomerUpdateDefaultAddressPayload = { __typename?: 'CustomerUpdateDefaultAddressPayload'; /** The customer whose address was updated. */ customer?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `customerUpdate` mutation. */ export type CustomerUpdatePayload = { __typename?: 'CustomerUpdatePayload'; /** The updated customer. */ customer?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Information about a customer's session on a shop's online store. */ export type CustomerVisit = CustomerMoment & Node & { __typename?: 'CustomerVisit'; /** Globally unique identifier. */ id: Scalars['ID']; /** URL of the first page the customer landed on for the session. */ landingPage?: Maybe; /** Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1. */ landingPageHtml?: Maybe; /** * Represent actions taken by an app, on behalf of a merchant, * to market Shopify resources such as products, collections, and discounts. */ marketingEvent?: Maybe; /** When the customer moment occurred. */ occurredAt: Scalars['DateTime']; /** * Marketing referral code from the link that the customer clicked to visit the store. * Supports the following URL attributes: _ref_, _source_, or _r_. * For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. */ referralCode?: Maybe; /** Referral information with URLs linked in HTML. */ referralInfoHtml: Scalars['FormattedString']; /** * Webpage where the customer clicked a link that sent them to the online store. * For example, _https://randomblog.com/page1_ or _android-app://com.google.android.gm_. */ referrerUrl?: Maybe; /** * Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, * a website domain, QR code, or unknown. */ source: Scalars['String']; /** Describes the source explicitly for first or last session. */ sourceDescription?: Maybe; /** Type of marketing tactic. */ sourceType?: Maybe; /** A set of UTM parameters gathered from the URL parameters of the referrer. */ utmParameters?: Maybe; }; /** Days of the week from Monday to Sunday. */ export enum DayOfTheWeek { /** Monday. */ Monday = 'MONDAY', /** Tuesday. */ Tuesday = 'TUESDAY', /** Wednesday. */ Wednesday = 'WEDNESDAY', /** Thursday. */ Thursday = 'THURSDAY', /** Friday. */ Friday = 'FRIDAY', /** Saturday. */ Saturday = 'SATURDAY', /** Sunday. */ Sunday = 'SUNDAY' } /** * Deletion events chronicle the destruction of resources (e.g. products and collections). * Once deleted, the deletion event is the only trace of the original's existence, * as the resource itself has been removed and can no longer be accessed. */ export type DeletionEvent = { __typename?: 'DeletionEvent'; /** The date and time when the deletion event for the related resource was generated. */ occurredAt: Scalars['DateTime']; /** The id of the resource that was deleted. */ subjectId: Scalars['ID']; /** The type of resource that was deleted. */ subjectType: DeletionEventSubjectType; }; /** An auto-generated type for paginating through multiple DeletionEvents. */ export type DeletionEventConnection = { __typename?: 'DeletionEventConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DeletionEvent and a cursor during pagination. */ export type DeletionEventEdge = { __typename?: 'DeletionEventEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DeletionEventEdge. */ node: DeletionEvent; }; /** The set of valid sort keys for the DeletionEvent query. */ export enum DeletionEventSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The supported subject types of deletion events. */ export enum DeletionEventSubjectType { Collection = 'COLLECTION', Product = 'PRODUCT' } /** The service and the countries they are available for. */ export type DeliveryAvailableService = { __typename?: 'DeliveryAvailableService'; /** The countries the service provider ships to. */ countries: DeliveryCountryCodesOrRestOfWorld; /** The name of the service. */ name: Scalars['String']; }; /** Information about a carrier or service provider. */ export type DeliveryCarrierService = Node & { __typename?: 'DeliveryCarrierService'; /** Services offered for given destinations. */ availableServicesForCountries: Array; /** The properly formatted name of the service provider, ready to display. */ formattedName?: Maybe; /** The logo of the service provider. */ icon: Image; /** Globally unique identifier. */ id: Scalars['ID']; /** The name of the service provider. */ name?: Maybe; }; /** Information about a carrier or service provider. */ export type DeliveryCarrierServiceAvailableServicesForCountriesArgs = { origins?: Maybe>; countryCodes?: Maybe>; restOfWorld: Scalars['Boolean']; }; /** A carrier services and their set of shop locations that can be used. */ export type DeliveryCarrierServiceAndLocations = { __typename?: 'DeliveryCarrierServiceAndLocations'; /** The carrier service. */ carrierService: DeliveryCarrierService; /** The locations that support this carrier service. */ locations: Array; }; /** A condition that must pass for a method definition to be applied to an order. */ export type DeliveryCondition = Node & { __typename?: 'DeliveryCondition'; /** The criteria (weight or price) that the field must meet based on the operator. */ conditionCriteria: DeliveryConditionCriteria; /** The field to compare the criteria unit against, using the operator. */ field: DeliveryConditionField; /** Globally unique identifier. */ id: Scalars['ID']; /** The operator to compare the field and criteria. */ operator: DeliveryConditionOperator; }; /** The criteria (weight or price) that the field must meet based on the operator. */ export type DeliveryConditionCriteria = MoneyV2 | Weight; /** The field type that the condition will be applied to. */ export enum DeliveryConditionField { /** Condition will check against the total weight of the order. */ TotalWeight = 'TOTAL_WEIGHT', /** Condition will check against the total price of the order. */ TotalPrice = 'TOTAL_PRICE' } /** The operator to use to determine if the condition passes. */ export enum DeliveryConditionOperator { /** The condition will check if the field is greater than or equal to the criteria. */ GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', /** The condition will check if the field is less than or equal to the criteria. */ LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO' } /** A country that is used to define a zone. */ export type DeliveryCountry = Node & { __typename?: 'DeliveryCountry'; /** The ISO 3166-1 alpha-2 country code of this country and a flag indicating Rest Of World. */ code: DeliveryCountryCodeOrRestOfWorld; /** Globally unique identifier. */ id: Scalars['ID']; /** The name of the country. */ name: Scalars['String']; /** The regions associated with this country. */ provinces: Array; /** The name of the country, translated based on the user locale. */ translatedName: Scalars['String']; }; /** A country with the name of the zone. */ export type DeliveryCountryAndZone = { __typename?: 'DeliveryCountryAndZone'; /** The country in the delivery zone. */ country: DeliveryCountry; /** The name of the delivery zone. */ zone: Scalars['String']; }; /** The ISO 3166-1 alpha-2 country code and a flag indicating Rest Of World. */ export type DeliveryCountryCodeOrRestOfWorld = { __typename?: 'DeliveryCountryCodeOrRestOfWorld'; /** The country code. */ countryCode?: Maybe; /** Indicates if 'Rest of World' is applied. */ restOfWorld: Scalars['Boolean']; }; /** A list of ISO 3166-1 alpha-2 country codes or the 'Rest of World'. */ export type DeliveryCountryCodesOrRestOfWorld = { __typename?: 'DeliveryCountryCodesOrRestOfWorld'; /** List of applicable country codes. */ countryCodes: Array; /** Indicates if 'Rest of World' is applied. */ restOfWorld: Scalars['Boolean']; }; /** Input fields to specify a country. */ export type DeliveryCountryInput = { /** The country code of the country. */ code?: Maybe; /** Use Rest of World as the country. */ restOfWorld?: Maybe; /** The regions associated with this country. */ provinces?: Maybe>; /** Associate all available provinces with this country. */ includeAllProvinces?: Maybe; }; /** Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned. */ export type DeliveryLegacyModeBlocked = { __typename?: 'DeliveryLegacyModeBlocked'; /** Whether the shop can convert to full multi-location delivery profiles mode. */ blocked: Scalars['Boolean']; /** The reasons why the shop is blocked from converting to full multi-location delivery profiles mode. */ reasons?: Maybe>; }; /** Reasons the shop is blocked from converting to full multi-location delivery profiles mode. */ export enum DeliveryLegacyModeBlockedReason { /** Multi-Location is disabled. */ MultiLocationDisabled = 'MULTI_LOCATION_DISABLED', /** No locations that can fulfill online orders. */ NoLocationsFulfillingOnlineOrders = 'NO_LOCATIONS_FULFILLING_ONLINE_ORDERS' } /** A location group is a collection of active locations that share zone and delivery methods across delivery profiles. */ export type DeliveryLocationGroup = Node & { __typename?: 'DeliveryLocationGroup'; /** Globally unique identifier. */ id: Scalars['ID']; /** List of active locations that are part of this location group. */ locations: LocationConnection; }; /** A location group is a collection of active locations that share zone and delivery methods across delivery profiles. */ export type DeliveryLocationGroupLocationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; includeLegacy?: Maybe; includeInactive?: Maybe; }; /** Links a location group and zone with the associated method definitions in a delivery profile. */ export type DeliveryLocationGroupZone = { __typename?: 'DeliveryLocationGroupZone'; /** The number of method definitions in this zone. */ methodDefinitionCounts: DeliveryMethodDefinitionCounts; /** The method definitions associated to a zone and location group in a delivery profile. */ methodDefinitions: DeliveryMethodDefinitionConnection; /** The zone associated to a location group in a delivery profile. */ zone: DeliveryZone; }; /** Links a location group and zone with the associated method definitions in a delivery profile. */ export type DeliveryLocationGroupZoneMethodDefinitionsArgs = { eligible?: Maybe; type?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** An auto-generated type for paginating through multiple DeliveryLocationGroupZones. */ export type DeliveryLocationGroupZoneConnection = { __typename?: 'DeliveryLocationGroupZoneConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DeliveryLocationGroupZone and a cursor during pagination. */ export type DeliveryLocationGroupZoneEdge = { __typename?: 'DeliveryLocationGroupZoneEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DeliveryLocationGroupZoneEdge. */ node: DeliveryLocationGroupZone; }; /** Input fields for a delivery zone associated to a location group and profile. */ export type DeliveryLocationGroupZoneInput = { /** Globally unique identifier of the Zone. */ id?: Maybe; /** The name of the zone. */ name?: Maybe; /** Countries to associate with the zone. */ countries?: Maybe>; /** Method definitions to create. */ methodDefinitionsToCreate?: Maybe>; /** Method definitions to update. */ methodDefinitionsToUpdate?: Maybe>; }; /** Delivery method. */ export type DeliveryMethod = Node & { __typename?: 'DeliveryMethod'; /** Globally unique identifier. */ id: Scalars['ID']; /** The type of the delivery method. */ methodType: DeliveryMethodType; }; /** A method definition describes the delivery rate and the conditions that must be met for the method to be applied. */ export type DeliveryMethodDefinition = Node & { __typename?: 'DeliveryMethodDefinition'; /** Whether this method definition is active. */ active: Scalars['Boolean']; /** The description of the method definition. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The method conditions that must pass for this method definition to be applied to an order. */ methodConditions: Array; /** The name of the method definition. */ name: Scalars['String']; /** Provided rate for this method definition, from a rate definition or participant. */ rateProvider: DeliveryRateProvider; }; /** An auto-generated type for paginating through multiple DeliveryMethodDefinitions. */ export type DeliveryMethodDefinitionConnection = { __typename?: 'DeliveryMethodDefinitionConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Then number of method definitions in a zone, separated into merchant-owned and participant definitions. */ export type DeliveryMethodDefinitionCounts = { __typename?: 'DeliveryMethodDefinitionCounts'; /** The number of participant method definitions in the current zone. */ participantDefinitionsCount: Scalars['Int']; /** The number of merchant-defined method definitions in the current zone. */ rateDefinitionsCount: Scalars['Int']; }; /** An auto-generated type which holds one DeliveryMethodDefinition and a cursor during pagination. */ export type DeliveryMethodDefinitionEdge = { __typename?: 'DeliveryMethodDefinitionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DeliveryMethodDefinitionEdge. */ node: DeliveryMethodDefinition; }; /** Input fields for a method definition. */ export type DeliveryMethodDefinitionInput = { /** Globally unique identifier of the method definition. Use only when updating a method definiton. */ id?: Maybe; /** The name of the method definition. */ name?: Maybe; /** The description of the method definition. */ description?: Maybe; /** Whether or not to use this method definition during rate calculation. */ active?: Maybe; /** A rate definition to apply to the method definition. */ rateDefinition?: Maybe; /** A participant to apply to the method definition. */ participant?: Maybe; /** Weight conditions on the method definition. */ weightConditionsToCreate?: Maybe>; /** Price conditions on the method definition. */ priceConditionsToCreate?: Maybe>; /** Conditions on the method definition to update. */ conditionsToUpdate?: Maybe>; }; /** The different types of method definitions to filter by. */ export enum DeliveryMethodDefinitionType { /** Static mechant-defined rates. */ Merchant = 'MERCHANT', /** Dynamic participant rates. */ Participant = 'PARTICIPANT' } /** Possible method types that a delivery method can have. */ export enum DeliveryMethodType { /** Shipping delivery method. */ Shipping = 'SHIPPING', /** Pick-up delivery method. */ PickUp = 'PICK_UP', /** No delivery method. */ None = 'NONE', /** Retail delivery method represents items delivered immediately in a retail store. */ Retail = 'RETAIL', /** Local delivery method. */ Local = 'LOCAL' } /** A carrier-defined rate with possible merchant-defined fixed fee or percentage-of-rate fee. */ export type DeliveryParticipant = Node & { __typename?: 'DeliveryParticipant'; /** Flag to indicate if new available services should be included. */ adaptToNewServicesFlag: Scalars['Boolean']; /** Use this carrier service for this participant. */ carrierService: DeliveryCarrierService; /** The merchant-set fixed fee for this participant. */ fixedFee?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** Services offered by the participant and their active status. */ participantServices: Array; /** The merchant-set percentage-of-rate fee for this participant. */ percentageOfRateFee: Scalars['Float']; }; /** Input fields for a participant. */ export type DeliveryParticipantInput = { /** Globally unique identifier of the participant. */ id?: Maybe; /** Global identifier of the carrier service. */ carrierServiceId?: Maybe; /** The merchant-set fixed fee for this participant. */ fixedFee?: Maybe; /** The merchant-set percentage-of-rate fee for this participant. */ percentageOfRateFee?: Maybe; /** Services offered by the participant and their active status. */ participantServices?: Maybe>; /** Flag to indicate if new available services should be included. */ adaptToNewServices?: Maybe; }; /** A service provided by a participant. */ export type DeliveryParticipantService = { __typename?: 'DeliveryParticipantService'; /** If the service is active or not. */ active: Scalars['Boolean']; /** Name of the service. */ name: Scalars['String']; }; /** Input fields for a service provided by a participant. */ export type DeliveryParticipantServiceInput = { /** Name of the service. */ name: Scalars['String']; /** If the service is active or not. */ active: Scalars['Boolean']; }; /** Input fields for the price-based conditions of a method definition. */ export type DeliveryPriceConditionInput = { /** The criteria for the price. */ criteria?: Maybe; /** The operator to use for comparison. */ operator?: Maybe; }; /** How many product variants are in a profile. This count is capped at 500. */ export type DeliveryProductVariantsCount = { __typename?: 'DeliveryProductVariantsCount'; /** If the count has reached the cap of 500. */ capped: Scalars['Boolean']; /** The product variant count. */ count: Scalars['Int']; }; /** A profile for multi-location, per-product delivery. */ export type DeliveryProfile = Node & { __typename?: 'DeliveryProfile'; /** The number of active shipping rates for the profile. */ activeMethodDefinitionsCount: Scalars['Int']; /** Whether this is the default profile. */ default: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** Whether this shop has enabled legacy compatibility mode for delivery profiles. */ legacyMode: Scalars['Boolean']; /** The number of locations without rates defined. */ locationsWithoutRatesCount: Scalars['Int']; /** The name of the delivery profile. */ name: Scalars['String']; /** The number of active origin locations for the profile. */ originLocationCount: Scalars['Int']; /** * The number of product variants for this profile. The count for the default profile is not supported and will return -1. * @deprecated Use `productVariantsCountV2` instead */ productVariantsCount: Scalars['Int']; /** How many product variants are in this profile. */ productVariantsCountV2: DeliveryProductVariantsCount; /** The products and variants associated with this profile. */ profileItems: DeliveryProfileItemConnection; /** The location groups and associated zones using this profile. */ profileLocationGroups: Array; /** Selling Plan Groups associated with the specified Delivery Profile. */ sellingPlanGroups: SellingPlanGroupConnection; /** List of locations that have not been assigned to a location group for this profile. */ unassignedLocations: Array; /** The number of countries with active rates to deliver to. */ zoneCountryCount: Scalars['Int']; }; /** A profile for multi-location, per-product delivery. */ export type DeliveryProfileProfileItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** A profile for multi-location, per-product delivery. */ export type DeliveryProfileSellingPlanGroupsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An auto-generated type for paginating through multiple DeliveryProfiles. */ export type DeliveryProfileConnection = { __typename?: 'DeliveryProfileConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DeliveryProfile and a cursor during pagination. */ export type DeliveryProfileEdge = { __typename?: 'DeliveryProfileEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DeliveryProfileEdge. */ node: DeliveryProfile; }; /** Input fields for a delivery profile. */ export type DeliveryProfileInput = { /** The name of the profile. */ name?: Maybe; /** The location groups associated with the profile. */ profileLocationGroups?: Maybe>; /** The location groups to be created in the profile. */ locationGroupsToCreate?: Maybe>; /** The location groups to be updated in the profile. */ locationGroupsToUpdate?: Maybe>; /** The location groups to be deleted in the profile. */ locationGroupsToDelete?: Maybe>; /** The product variant ids to be associated with this profile. */ variantsToAssociate?: Maybe>; /** The product variant ids to be dissociated from this profile and returned to the default profile. */ variantsToDissociate?: Maybe>; /** Zones to delete. */ zonesToDelete?: Maybe>; /** Method definitions to delete. */ methodDefinitionsToDelete?: Maybe>; /** Conditions to delete. */ conditionsToDelete?: Maybe>; /** The selling plan groups to be associated with this profile. */ sellingPlanGroupsToAssociate?: Maybe>; /** The selling plan groups to be dissociated with this profile. */ sellingPlanGroupsToDissociate?: Maybe>; }; /** A product and the subset of associated variants that are part of this delivery profile. */ export type DeliveryProfileItem = { __typename?: 'DeliveryProfileItem'; /** A product associated with this profile. */ product: Product; /** The product variants associated with this delivery profile. */ variants: ProductVariantConnection; }; /** A product and the subset of associated variants that are part of this delivery profile. */ export type DeliveryProfileItemVariantsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** An auto-generated type for paginating through multiple DeliveryProfileItems. */ export type DeliveryProfileItemConnection = { __typename?: 'DeliveryProfileItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DeliveryProfileItem and a cursor during pagination. */ export type DeliveryProfileItemEdge = { __typename?: 'DeliveryProfileItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DeliveryProfileItemEdge. */ node: DeliveryProfileItem; }; /** Links a location group with zones associated to a delivery profile. */ export type DeliveryProfileLocationGroup = { __typename?: 'DeliveryProfileLocationGroup'; /** The countries already selected in any zone for the given location group and profile. */ countriesInAnyZone: Array; /** The location group associated to a delivery profile. */ locationGroup: DeliveryLocationGroup; /** The applicable zones associated to a location group and delivery profile. */ locationGroupZones: DeliveryLocationGroupZoneConnection; }; /** Links a location group with zones associated to a delivery profile. */ export type DeliveryProfileLocationGroupLocationGroupZonesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Input fields for a delivery location group associated to a profile. */ export type DeliveryProfileLocationGroupInput = { /** Globally unique identifier of the LocationGroup. */ id?: Maybe; /** The location ids of the locations to be moved to this location group. */ locations?: Maybe>; /** Zones to create. */ zonesToCreate?: Maybe>; /** Zones to update. */ zonesToUpdate?: Maybe>; }; /** A region that is used to define a zone. */ export type DeliveryProvince = Node & { __typename?: 'DeliveryProvince'; /** The code of this region. */ code: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The name of the region. */ name: Scalars['String']; /** The name of the region, translated based on the user locale. */ translatedName: Scalars['String']; }; /** The input fields to specify a region. */ export type DeliveryProvinceInput = { /** The code of the region. */ code: Scalars['String']; }; /** The merchant-defined rate of the DeliveryMethodDefinition. */ export type DeliveryRateDefinition = Node & { __typename?: 'DeliveryRateDefinition'; /** Globally unique identifier. */ id: Scalars['ID']; /** The price of this rate. */ price: MoneyV2; }; /** Input fields for a rate definition. */ export type DeliveryRateDefinitionInput = { /** Globally unique identifier of the rate definition. */ id?: Maybe; /** The price of the rate definition. */ price: MoneyInput; }; /** Rate provided by a rate definition or a participant. */ export type DeliveryRateProvider = DeliveryParticipant | DeliveryRateDefinition; /** Delivery shop-level settings. */ export type DeliverySetting = { __typename?: 'DeliverySetting'; /** Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned. */ legacyModeBlocked: DeliveryLegacyModeBlocked; /** Enables legacy compatability mode for the multi-location delivery profiles feature. */ legacyModeProfiles: Scalars['Boolean']; }; /** Input fields for shop-level delivery settings. */ export type DeliverySettingInput = { /** Enables legacy compatability mode for the multi-location delivery profiles feature. */ legacyModeProfiles?: Maybe; }; /** Return type for `deliverySettingUpdate` mutation. */ export type DeliverySettingUpdatePayload = { __typename?: 'DeliverySettingUpdatePayload'; /** The updated delivery shop level settings. */ setting?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `deliveryShippingOriginAssign` mutation. */ export type DeliveryShippingOriginAssignPayload = { __typename?: 'DeliveryShippingOriginAssignPayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Input fields for updating the conditions of a method definition. */ export type DeliveryUpdateConditionInput = { /** Globally unique identifier of the condition. */ id: Scalars['ID']; /** The value of the criteria of the condition. */ criteria?: Maybe; /** The unit of the criteria of the condition. */ criteriaUnit?: Maybe; /** The field to use, either total_weight or total_price. */ field?: Maybe; /** The operator to use for comparison. */ operator?: Maybe; }; /** Input fields for the weight-based conditions of a method definition. */ export type DeliveryWeightConditionInput = { /** The criteria for the weight. */ criteria?: Maybe; /** The operator to use for comparison. */ operator?: Maybe; }; /** A zone is a geographical area that contains delivery methods within a delivery profile. */ export type DeliveryZone = Node & { __typename?: 'DeliveryZone'; /** The list of countries within the zone. */ countries: Array; /** Globally unique identifier. */ id: Scalars['ID']; /** The name of the zone. */ name: Scalars['String']; }; /** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ export enum DigitalWallet { /** Apple Pay. */ ApplePay = 'APPLE_PAY', /** Android Pay. */ AndroidPay = 'ANDROID_PAY', /** Google Pay. */ GooglePay = 'GOOGLE_PAY', /** Shopify Pay. */ ShopifyPay = 'SHOPIFY_PAY' } /** An amount discounting the line that has been allocated by an associated discount application. */ export type DiscountAllocation = { __typename?: 'DiscountAllocation'; /** * Money amount allocated by the discount application. * @deprecated Use `allocatedAmountSet` instead */ allocatedAmount: MoneyV2; /** Money amount allocated by the discount application in shop and presentment currencies. */ allocatedAmountSet: MoneyBag; /** The discount of which this allocated amount originated from. */ discountApplication: DiscountApplication; }; /** The fixed amount value of a discount. */ export type DiscountAmount = { __typename?: 'DiscountAmount'; /** The value of the discount. */ amount: MoneyV2; /** If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. */ appliesOnEachItem: Scalars['Boolean']; }; /** Specifies the value of the discount and how it is applied. */ export type DiscountAmountInput = { /** The value of the discount. */ amount?: Maybe; /** If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. */ appliesOnEachItem?: Maybe; }; /** * Discount applications capture the intentions of a discount source at * the time of application on an order's line items or shipping lines. */ export type DiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** * An ordered index that can be used to identify the discount application and indicate the precedence * of the discount application for calculations. */ index: Scalars['Int']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ 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 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 type DiscountApplicationConnection = { __typename?: 'DiscountApplicationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DiscountApplication and a cursor during pagination. */ export type DiscountApplicationEdge = { __typename?: 'DiscountApplicationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DiscountApplicationEdge. */ node: DiscountApplication; }; /** The method by which the discount's value is allocated onto its entitled lines. */ export enum DiscountApplicationLevel { /** * The discount was applied at the order level. * Order level discounts are not factored into the discountedUnitPriceSet on line items. */ Order = 'ORDER', /** * The discount was applied at the line level. * Line level discounts are factored into the discountedUnitPriceSet on line items. */ Line = 'LINE' } /** * Which lines on the order that the discount is allocated over, of the type * defined by the Discount Application's target_type. */ export enum DiscountApplicationTargetSelection { /** The discount is allocated onto all the lines. */ All = 'ALL', /** The discount is allocated onto only the lines it is entitled for. */ 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 enum DiscountApplicationTargetType { /** The discount applies onto line items. */ LineItem = 'LINE_ITEM', /** The discount applies onto shipping lines. */ ShippingLine = 'SHIPPING_LINE' } /** An automatic discount. */ export type DiscountAutomatic = DiscountAutomaticBasic | DiscountAutomaticBxgy; /** Return type for `discountAutomaticActivate` mutation. */ export type DiscountAutomaticActivatePayload = { __typename?: 'DiscountAutomaticActivatePayload'; /** The activated automatic discount. */ automaticDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An automatic basic discount. */ export type DiscountAutomaticBasic = { __typename?: 'DiscountAutomaticBasic'; /** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */ asyncUsageCount: Scalars['Int']; /** The date and time when the discount was created. */ createdAt: Scalars['DateTime']; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets: DiscountCustomerGets; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** The minimum subtotal or quantity that's required for the discount to be applied. */ minimumRequirement: DiscountMinimumRequirement; /** A short summary of the discount. */ shortSummary: Scalars['String']; /** The date and time when the discount starts. */ startsAt: Scalars['DateTime']; /** The status of the discount. */ status: DiscountStatus; /** A detailed summary of the discount. */ summary: Scalars['String']; /** The title of the discount. */ title: Scalars['String']; /** * The number of times that the discount has been used. * @deprecated Use `asyncUsageCount` instead */ usageCount: Scalars['Int']; }; /** Return type for `discountAutomaticBasicCreate` mutation. */ export type DiscountAutomaticBasicCreatePayload = { __typename?: 'DiscountAutomaticBasicCreatePayload'; /** The created automatic discount. */ automaticDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies input field to create or update automatic basic discount. */ export type DiscountAutomaticBasicInput = { /** The title of the discount. */ title?: Maybe; /** The date and time when the discount starts. */ startsAt?: Maybe; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** The minimum subtotal or quantity that's required for the discount to be applied. */ minimumRequirement?: Maybe; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets?: Maybe; }; /** Return type for `discountAutomaticBasicUpdate` mutation. */ export type DiscountAutomaticBasicUpdatePayload = { __typename?: 'DiscountAutomaticBasicUpdatePayload'; /** The updated automatic discount. */ automaticDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `discountAutomaticBulkDelete` mutation. */ export type DiscountAutomaticBulkDeletePayload = { __typename?: 'DiscountAutomaticBulkDeletePayload'; /** The asynchronous job removing the automatic discounts. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An automatic BXGY discount. */ export type DiscountAutomaticBxgy = Node & HasEvents & { __typename?: 'DiscountAutomaticBxgy'; /** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */ asyncUsageCount: Scalars['Int']; /** The date and time when the discount was created. */ createdAt: Scalars['DateTime']; /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ customerBuys: DiscountCustomerBuys; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets: DiscountCustomerGets; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** The paginated list of events associated with the host subject. */ events: EventConnection; /** * A legacy unique identifier for the discount. * @deprecated Use DiscountAutomaticNode.id instead. */ id: Scalars['ID']; /** The date and time when the discount starts. */ startsAt: Scalars['DateTime']; /** The status of the discount. */ status: DiscountStatus; /** A detailed summary of the discount. */ summary: Scalars['String']; /** The title of the discount. */ title: Scalars['String']; /** * The number of times that the discount has been used. * @deprecated Use `asyncUsageCount` instead */ usageCount: Scalars['Int']; /** The maximum number of times that the discount can be applied to an order. */ usesPerOrderLimit?: Maybe; }; /** An automatic BXGY discount. */ export type DiscountAutomaticBxgyEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Return type for `discountAutomaticBxgyCreate` mutation. */ export type DiscountAutomaticBxgyCreatePayload = { __typename?: 'DiscountAutomaticBxgyCreatePayload'; /** The created automatic discount. */ automaticDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies input field to create or update automatic bogo discount. */ export type DiscountAutomaticBxgyInput = { /** The date and time when the discount starts. */ startsAt?: Maybe; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** The title of the discount. */ title?: Maybe; /** The maximum number of times that the discount can be applied to an order. */ usesPerOrderLimit?: Maybe; /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ customerBuys?: Maybe; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets?: Maybe; }; /** Return type for `discountAutomaticBxgyUpdate` mutation. */ export type DiscountAutomaticBxgyUpdatePayload = { __typename?: 'DiscountAutomaticBxgyUpdatePayload'; /** The updated automatic discount. */ automaticDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple DiscountAutomatics. */ export type DiscountAutomaticConnection = { __typename?: 'DiscountAutomaticConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `discountAutomaticDeactivate` mutation. */ export type DiscountAutomaticDeactivatePayload = { __typename?: 'DiscountAutomaticDeactivatePayload'; /** The deactivated automatic discount. */ automaticDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `discountAutomaticDelete` mutation. */ export type DiscountAutomaticDeletePayload = { __typename?: 'DiscountAutomaticDeletePayload'; /** The deleted automatic discount ID. */ deletedAutomaticDiscountId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one DiscountAutomatic and a cursor during pagination. */ export type DiscountAutomaticEdge = { __typename?: 'DiscountAutomaticEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DiscountAutomaticEdge. */ node: DiscountAutomatic; }; /** An automatic discount wrapper node. */ export type DiscountAutomaticNode = Node & HasEvents & { __typename?: 'DiscountAutomaticNode'; /** An automatic discount. */ automaticDiscount: DiscountAutomatic; /** The paginated list of events associated with the host subject. */ events: EventConnection; /** Globally unique identifier. */ id: Scalars['ID']; }; /** An automatic discount wrapper node. */ export type DiscountAutomaticNodeEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** An auto-generated type for paginating through multiple DiscountAutomaticNodes. */ export type DiscountAutomaticNodeConnection = { __typename?: 'DiscountAutomaticNodeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DiscountAutomaticNode and a cursor during pagination. */ export type DiscountAutomaticNodeEdge = { __typename?: 'DiscountAutomaticNodeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DiscountAutomaticNodeEdge. */ node: DiscountAutomaticNode; }; /** A code discount. */ export type DiscountCode = DiscountCodeBasic | DiscountCodeBxgy | DiscountCodeFreeShipping; /** Return type for `discountCodeActivate` mutation. */ export type DiscountCodeActivatePayload = { __typename?: 'DiscountCodeActivatePayload'; /** The activated code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Discount code applications capture the intentions of a discount code at * the time that it is applied onto an order. */ export type DiscountCodeApplication = DiscountApplication & { __typename?: 'DiscountCodeApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The string identifying the discount code that was used at the time of application. */ code: Scalars['String']; /** * An ordered index that can be used to identify the discount application and indicate the precedence * of the discount application for calculations. */ index: Scalars['Int']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** A basic code discount. */ export type DiscountCodeBasic = { __typename?: 'DiscountCodeBasic'; /** Whether the discount can be applied only once per customer. */ appliesOncePerCustomer: Scalars['Boolean']; /** The number of times that the discount has been used. */ asyncUsageCount: Scalars['Int']; /** The number of redeem codes for the discount. */ codeCount: Scalars['Int']; /** A list of redeem codes for the discount. */ codes: DiscountRedeemCodeConnection; /** The date and time when the discount was created. */ createdAt: Scalars['DateTime']; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets: DiscountCustomerGets; /** The customers that can use the discount. */ customerSelection: DiscountCustomerSelection; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** Indicates whether there are any timeline comments on the discount. */ hasTimelineComment: Scalars['Boolean']; /** The minimum subtotal or quantity that's required for the discount to be applied. */ minimumRequirement?: Maybe; /** The number of times a discount applies on recurring purchases (subscriptions). */ recurringCycleLimit?: Maybe; /** URLs that can be used to share the discount. */ shareableUrls: Array; /** A short summary of the discount. */ shortSummary: Scalars['String']; /** The date and time when the discount starts. */ startsAt: Scalars['DateTime']; /** The status of the discount. */ status: DiscountStatus; /** A detailed summary of the discount. */ summary: Scalars['String']; /** The title of the discount. */ title: Scalars['String']; /** The total sales from orders where the discount was used. */ totalSales?: Maybe; /** The maximum number of times that the discount can be used. */ usageLimit?: Maybe; }; /** A basic code discount. */ export type DiscountCodeBasicCodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Return type for `discountCodeBasicCreate` mutation. */ export type DiscountCodeBasicCreatePayload = { __typename?: 'DiscountCodeBasicCreatePayload'; /** The created code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies input field to create or update code basic discount. */ export type DiscountCodeBasicInput = { /** The title of the discount. */ title?: Maybe; /** The date and time when the discount starts. */ startsAt?: Maybe; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */ usageLimit?: Maybe; /** Whether the discount can be applied only once per customer. */ appliesOncePerCustomer?: Maybe; /** The minimum subtotal or quantity that's required for the discount to be applied. */ minimumRequirement?: Maybe; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets?: Maybe; /** The customers that can use the discount. */ customerSelection?: Maybe; /** The code to use the discount. */ code?: Maybe; /** The number of times a discount applies on recurring purchases (subscriptions). */ recurringCycleLimit?: Maybe; }; /** Return type for `discountCodeBasicUpdate` mutation. */ export type DiscountCodeBasicUpdatePayload = { __typename?: 'DiscountCodeBasicUpdatePayload'; /** The updated code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `discountCodeBulkActivate` mutation. */ export type DiscountCodeBulkActivatePayload = { __typename?: 'DiscountCodeBulkActivatePayload'; /** The asynchronous job that activates the code discounts. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `discountCodeBulkDeactivate` mutation. */ export type DiscountCodeBulkDeactivatePayload = { __typename?: 'DiscountCodeBulkDeactivatePayload'; /** The asynchronous job that deactivates the code discounts. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `discountCodeBulkDelete` mutation. */ export type DiscountCodeBulkDeletePayload = { __typename?: 'DiscountCodeBulkDeletePayload'; /** The asynchronous job that deletes the code discounts. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** A BXGY code discount. */ export type DiscountCodeBxgy = { __typename?: 'DiscountCodeBxgy'; /** Whether the discount can be applied only once per customer. */ appliesOncePerCustomer: Scalars['Boolean']; /** The number of times that the discount has been used. */ asyncUsageCount: Scalars['Int']; /** The number of redeem codes for the discount. */ codeCount: Scalars['Int']; /** A list of redeem codes for the discount. */ codes: DiscountRedeemCodeConnection; /** The date and time when the discount was created. */ createdAt: Scalars['DateTime']; /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ customerBuys: DiscountCustomerBuys; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets: DiscountCustomerGets; /** The customers that can use the discount. */ customerSelection: DiscountCustomerSelection; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** Indicates whether there are any timeline comments on the discount. */ hasTimelineComment: Scalars['Boolean']; /** URLs that can be used to share the discount. */ shareableUrls: Array; /** The date and time when the discount starts. */ startsAt: Scalars['DateTime']; /** The status of the discount. */ status: DiscountStatus; /** A detailed summary of the discount. */ summary: Scalars['String']; /** The title of the discount. */ title: Scalars['String']; /** The total sales from orders where the discount was used. */ totalSales?: Maybe; /** The maximum number of times that the discount can be used. */ usageLimit?: Maybe; /** The maximum number of times that the discount can be applied to an order. */ usesPerOrderLimit?: Maybe; }; /** A BXGY code discount. */ export type DiscountCodeBxgyCodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Return type for `discountCodeBxgyCreate` mutation. */ export type DiscountCodeBxgyCreatePayload = { __typename?: 'DiscountCodeBxgyCreatePayload'; /** The created code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies input field to create or update a BXGY code discount. */ export type DiscountCodeBxgyInput = { /** The title of the discount. */ title?: Maybe; /** The date and time when the discount starts. */ startsAt?: Maybe; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ customerBuys?: Maybe; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ customerGets?: Maybe; /** The customers that can use the discount. */ customerSelection?: Maybe; /** The code to use the discount. */ code?: Maybe; /** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */ usageLimit?: Maybe; /** The maximum number of times that the discount can be applied to an order. */ usesPerOrderLimit?: Maybe; /** Whether the discount can be applied only once per customer. */ appliesOncePerCustomer?: Maybe; }; /** Return type for `discountCodeBxgyUpdate` mutation. */ export type DiscountCodeBxgyUpdatePayload = { __typename?: 'DiscountCodeBxgyUpdatePayload'; /** The updated code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `discountCodeDeactivate` mutation. */ export type DiscountCodeDeactivatePayload = { __typename?: 'DiscountCodeDeactivatePayload'; /** The deactivated code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `discountCodeDelete` mutation. */ export type DiscountCodeDeletePayload = { __typename?: 'DiscountCodeDeletePayload'; /** The deleted code discount ID. */ deletedCodeDiscountId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** A free shipping code discount. */ export type DiscountCodeFreeShipping = { __typename?: 'DiscountCodeFreeShipping'; /** Whether the discount applies on regular one-time-purchase shipping lines. */ appliesOnOneTimePurchase: Scalars['Boolean']; /** Whether the discount applies on subscription shipping lines. */ appliesOnSubscription: Scalars['Boolean']; /** Whether the discount can be applied only once per customer. */ appliesOncePerCustomer: Scalars['Boolean']; /** The number of times that the discount has been used. */ asyncUsageCount: Scalars['Int']; /** The number of redeem codes for the discount. */ codeCount: Scalars['Int']; /** A list of redeem codes for the discount. */ codes: DiscountRedeemCodeConnection; /** The date and time when the discount was created. */ createdAt: Scalars['DateTime']; /** The customers that can use the discount. */ customerSelection: DiscountCustomerSelection; /** A shipping destination that qualifies for the discount. */ destinationSelection: DiscountShippingDestinationSelection; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** Indicates whether there are any timeline comments on the discount. */ hasTimelineComment: Scalars['Boolean']; /** The maximum shipping price amount accepted to qualify for the discount. */ maximumShippingPrice?: Maybe; /** The minimum subtotal or quantity that's required for the discount to be applied. */ minimumRequirement?: Maybe; /** The number of times a discount applies on recurring purchases (subscriptions). */ recurringCycleLimit?: Maybe; /** URLs that can be used to share the discount. */ shareableUrls: Array; /** A short summary of the discount. */ shortSummary: Scalars['String']; /** The date and time when the discount starts. */ startsAt: Scalars['DateTime']; /** The status of the discount. */ status: DiscountStatus; /** A detailed summary of the discount. */ summary: Scalars['String']; /** The title of the discount. */ title: Scalars['String']; /** The total sales from orders where the discount was used. */ totalSales?: Maybe; /** The maximum number of times that the discount can be used. */ usageLimit?: Maybe; }; /** A free shipping code discount. */ export type DiscountCodeFreeShippingCodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Return type for `discountCodeFreeShippingCreate` mutation. */ export type DiscountCodeFreeShippingCreatePayload = { __typename?: 'DiscountCodeFreeShippingCreatePayload'; /** The created code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies input field to create or update free shipping code discount. */ export type DiscountCodeFreeShippingInput = { /** The title of the discount. */ title?: Maybe; /** The date and time when the discount starts. */ startsAt?: Maybe; /** The date and time when the discount ends. For open-ended discounts, use `null`. */ endsAt?: Maybe; /** The code to use the discount. */ code?: Maybe; /** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */ usageLimit?: Maybe; /** Whether the discount can be applied only once per customer. */ appliesOncePerCustomer?: Maybe; /** The minimum subtotal or quantity that's required for the discount to be applied. */ minimumRequirement?: Maybe; /** The customers that can use the discount. */ customerSelection?: Maybe; /** A list of destinations where the discount will apply. */ destination?: Maybe; /** The maximum shipping price that qualifies for the discount. */ maximumShippingPrice?: Maybe; /** The number of times a discount applies on recurring purchases (subscriptions). */ recurringCycleLimit?: Maybe; /** Whether the discount applies on regular one-time-purchase items. */ appliesOnOneTimePurchase?: Maybe; /** Whether the discount applies on subscription items. */ appliesOnSubscription?: Maybe; }; /** Return type for `discountCodeFreeShippingUpdate` mutation. */ export type DiscountCodeFreeShippingUpdatePayload = { __typename?: 'DiscountCodeFreeShippingUpdatePayload'; /** The updated code discount. */ codeDiscountNode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** A code discount wrapper node. */ export type DiscountCodeNode = Node & HasEvents & { __typename?: 'DiscountCodeNode'; /** A code discount. */ codeDiscount: DiscountCode; /** The paginated list of events associated with the host subject. */ events: EventConnection; /** Globally unique identifier. */ id: Scalars['ID']; }; /** A code discount wrapper node. */ export type DiscountCodeNodeEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** An auto-generated type for paginating through multiple DiscountCodeNodes. */ export type DiscountCodeNodeConnection = { __typename?: 'DiscountCodeNodeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DiscountCodeNode and a cursor during pagination. */ export type DiscountCodeNodeEdge = { __typename?: 'DiscountCodeNodeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DiscountCodeNodeEdge. */ node: DiscountCodeNode; }; /** Return type for `discountCodeRedeemCodeBulkDelete` mutation. */ export type DiscountCodeRedeemCodeBulkDeletePayload = { __typename?: 'DiscountCodeRedeemCodeBulkDeletePayload'; /** The asynchronous job that deletes the discount redeem codes. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The set of valid sort keys for the DiscountCode query. */ export enum DiscountCodeSortKeys { /** Sort by the `code` value. */ Code = 'CODE', /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** A list of collections that the discount can have as a prerequisite or entitlement. */ export type DiscountCollections = { __typename?: 'DiscountCollections'; /** A list of collections that the discount can have as a prerequisite or entitlement. */ collections: CollectionConnection; }; /** A list of collections that the discount can have as a prerequisite or entitlement. */ export type DiscountCollectionsCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Specifies the collections attached to a discount. */ export type DiscountCollectionsInput = { /** Specifies list of collection ids to add. */ add?: Maybe>; /** Specifies list of collection ids to remove. */ remove?: Maybe>; }; /** The shipping destination where the discount applies. */ export type DiscountCountries = { __typename?: 'DiscountCountries'; /** The codes for the countries where the discount can be used. */ countries: Array; /** Whether the discount is applicable to countries that have not been defined in the shop's shipping zones. */ includeRestOfWorld: Scalars['Boolean']; }; /** Specifies a list of countries to add or remove from the free shipping discount. */ export type DiscountCountriesInput = { /** The country codes to add to the list of countries where the discount applies. */ add?: Maybe>; /** The country codes to remove from the list of countries where the discount applies. */ remove?: Maybe>; /** Whether the discount code is applicable to countries that have not been defined in the shop's shipping zones. */ includeRestOfWorld?: Maybe; }; /** Whether the discount applies to all countries. */ export type DiscountCountryAll = { __typename?: 'DiscountCountryAll'; /** Always true when resolved to this type. */ allCountries: Scalars['Boolean']; }; /** Whether the discount applies to all customers. */ export type DiscountCustomerAll = { __typename?: 'DiscountCustomerAll'; /** Always true when resolved to this type. */ allCustomers: Scalars['Boolean']; }; /** The prerequisite items and prerequisite value. */ export type DiscountCustomerBuys = { __typename?: 'DiscountCustomerBuys'; /** The items required for the discount to be applicable. */ items: DiscountItems; /** The prerequisite value. */ value: DiscountCustomerBuysValue; }; /** Specifies the prerequisite items and prerequisite quantity. */ export type DiscountCustomerBuysInput = { /** The quantity of prerequisite items. */ value?: Maybe; /** The IDs of items that the customer buys. The items can be either collections or products. */ items?: Maybe; }; /** The prerequisite quantity required for the discount to be applicable. */ export type DiscountCustomerBuysValue = DiscountPurchaseAmount | DiscountQuantity; /** Specifies the prerequisite quantity for the discount. */ export type DiscountCustomerBuysValueInput = { /** The quantity of prerequisite items. */ quantity?: Maybe; /** The prerequisite purchase amount required for the discount to be applicable. */ amount?: Maybe; }; /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ export type DiscountCustomerGets = { __typename?: 'DiscountCustomerGets'; /** Whether the discount applies on regular one-time-purchase items. */ appliesOnOneTimePurchase: Scalars['Boolean']; /** Whether the discount applies on subscription items. */ appliesOnSubscription: Scalars['Boolean']; /** The items to which the discount applies. */ items: DiscountItems; /** Entitled quantity and the discount value. */ value: DiscountCustomerGetsValue; }; /** Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount. */ export type DiscountCustomerGetsInput = { /** The quantity of items discounted and the discount value. */ value?: Maybe; /** The IDs of the items that the customer gets. The items can be either collections or products. */ items?: Maybe; /** Whether the discount applies on regular one-time-purchase items. */ appliesOnOneTimePurchase?: Maybe; /** Whether the discount applies on subscription items. */ appliesOnSubscription?: Maybe; }; /** The value of the discount and how it will be applied. */ export type DiscountCustomerGetsValue = DiscountAmount | DiscountOnQuantity | DiscountPercentage; /** Specifies the quantity of items discounted and the discount value. */ export type DiscountCustomerGetsValueInput = { /** The quantity of the items that are discounted and the discount value. */ discountOnQuantity?: Maybe; /** The percentage value of the discount. Value must be between 0.00 - 1.00. */ percentage?: Maybe; /** The value of the discount. */ discountAmount?: Maybe; }; /** A list of customer saved searches that contain the customers to whom the discount applies. */ export type DiscountCustomerSavedSearches = { __typename?: 'DiscountCustomerSavedSearches'; /** A list of customer saved searches that contain the customers who can use the discount. */ savedSearches: Array; }; /** Specifies which customer saved searches to add to or remove from the discount. */ export type DiscountCustomerSavedSearchesInput = { /** A list of customer saved searches to add to the current list of customer saved searches. */ add?: Maybe>; /** A list of customer saved searches to remove from the current list of customer saved searches. */ remove?: Maybe>; }; /** The selection of customers who can use this discount. */ export type DiscountCustomerSelection = DiscountCustomerAll | DiscountCustomerSavedSearches | DiscountCustomers; /** Specifies the customers who can use this discount. */ export type DiscountCustomerSelectionInput = { /** Whether all customers can use this discount. */ all?: Maybe; /** The list of customer IDs to add or remove from the list of customers. */ customers?: Maybe; /** The list of customer saved search IDs to add or remove from the list of customer saved searches. */ customerSavedSearches?: Maybe; }; /** A list of customers to whom the discount applies. */ export type DiscountCustomers = { __typename?: 'DiscountCustomers'; /** A list of the customers that can use the discount. */ customers: Array; }; /** Specifies which customers to add to or remove from the discount. */ export type DiscountCustomersInput = { /** A list of customers to add to the current list of customers who can use the discount. */ add?: Maybe>; /** A list of customers to remove from the current list of customers who can use the discount. */ remove?: Maybe>; }; /** The type of discount that will be applied. Currently, only percentage off is supported. */ export type DiscountEffect = DiscountPercentage; /** Specifies how the discount will be applied. Currently, only percentage off is supported. */ export type DiscountEffectInput = { /** The percentage value of the discount. Value must be between 0.00 - 1.00. */ percentage?: Maybe; }; /** Possible error codes that could be returned by DiscountUserError. */ export enum DiscountErrorCode { /** Input value is blank. */ Blank = 'BLANK', /** Input value is not present. */ Present = 'PRESENT', /** Input value should be equal to allowed value. */ EqualTo = 'EQUAL_TO', /** Input value should be greater than minimum allowed value. */ GreaterThan = 'GREATER_THAN', /** Input value should be greater than or equal to minimum allowed value. */ GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', /** Input value is invalid. */ Invalid = 'INVALID', /** Input value should be less or equal to maximum allowed value. */ LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO', /** Input value should be less than maximum allowed value. */ LessThan = 'LESS_THAN', /** Input value is already taken. */ Taken = 'TAKEN', /** Input value is too long. */ TooLong = 'TOO_LONG', /** Input value is too short. */ TooShort = 'TOO_SHORT', /** Unexpected internal error happened. */ InternalError = 'INTERNAL_ERROR', /** Too many arguments provided. */ TooManyArguments = 'TOO_MANY_ARGUMENTS', /** Missing a required argument. */ MissingArgument = 'MISSING_ARGUMENT', /** Value is outside allowed range. */ ValueOutsideRange = 'VALUE_OUTSIDE_RANGE', /** Exceeded maximum allowed value. */ ExceededMax = 'EXCEEDED_MAX', /** Cannot have both minimum subtotal and quantity present. */ MinimumSubtotalAndQuantityRangeBothPresent = 'MINIMUM_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT', /** Active period overlaps with other automatic discounts. At any given time, only one automatic discount can be active. */ ActivePeriodOverlap = 'ACTIVE_PERIOD_OVERLAP', /** Attribute selection contains conflicting settings. */ Conflict = 'CONFLICT', /** Value is already present through another selection. */ ImplicitDuplicate = 'IMPLICIT_DUPLICATE', /** Input value is already present. */ Duplicate = 'DUPLICATE', /** Input value is not included in the list. */ Inclusion = 'INCLUSION' } /** Entitled or prerequisite items on a discount. An item could be either collection or product or product_variant. */ export type DiscountItems = AllDiscountItems | DiscountCollections | DiscountProducts; /** Specifies the items attached to a discount. */ export type DiscountItemsInput = { /** The products and product variants that are attached to a discount. */ products?: Maybe; /** The collections that are attached to a discount. */ collections?: Maybe; /** Whether all items should be selected. */ all?: Maybe; }; /** The minimum quantity of items required for the discount to apply. */ export type DiscountMinimumQuantity = { __typename?: 'DiscountMinimumQuantity'; /** The minimum quantity of items that's required for the discount to be applied. */ greaterThanOrEqualToQuantity: Scalars['UnsignedInt64']; }; /** Specifies the quantity minimum requirements for a discount. */ export type DiscountMinimumQuantityInput = { /** The minimum quantity of items that's required for the discount to be applied. */ greaterThanOrEqualToQuantity?: Maybe; }; /** The minimum subtotal or quantity requirements for the discount. */ export type DiscountMinimumRequirement = DiscountMinimumQuantity | DiscountMinimumSubtotal; /** Specifies the quantity or subtotal minimum requirements for a discount. */ export type DiscountMinimumRequirementInput = { /** The minimum required quantity. */ quantity?: Maybe; /** The minimum required subtotal. */ subtotal?: Maybe; }; /** The minimum subtotal required for the discount to apply. */ export type DiscountMinimumSubtotal = { __typename?: 'DiscountMinimumSubtotal'; /** The minimum subtotal that's required for the discount to be applied. */ greaterThanOrEqualToSubtotal: MoneyV2; }; /** Specifies the subtotal minimum requirements for a discount. */ export type DiscountMinimumSubtotalInput = { /** The minimum subtotal that's required for the discount to be applied. */ greaterThanOrEqualToSubtotal?: Maybe; }; /** The quantity of items discounted, the discount value, and how the discount will be applied. */ export type DiscountOnQuantity = { __typename?: 'DiscountOnQuantity'; /** The discount's effect on qualifying items. */ effect: DiscountEffect; /** The number of items being discounted. */ quantity: DiscountQuantity; }; /** Specifies the quantity of items discounted and the discount value. */ export type DiscountOnQuantityInput = { /** The quantity of items that are discounted. */ quantity?: Maybe; /** The percentage value of the discount. */ effect?: Maybe; }; /** The percentage value of the discount. */ export type DiscountPercentage = { __typename?: 'DiscountPercentage'; /** The percentage value of the discount. */ percentage: Scalars['Float']; }; /** The entitled or prerequisite products and product variants for a discount. */ export type DiscountProducts = { __typename?: 'DiscountProducts'; /** A list of product variants that the discount can have as a prerequisite or entitlement. */ productVariants: ProductVariantConnection; /** A list of products that the discount can have as a prerequisite or entitlement. */ products: ProductConnection; }; /** The entitled or prerequisite products and product variants for a discount. */ export type DiscountProductsProductVariantsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The entitled or prerequisite products and product variants for a discount. */ export type DiscountProductsProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Specifies the products and product variants attached to a discount. */ export type DiscountProductsInput = { /** Specifies list of product ids to add. */ productsToAdd?: Maybe>; /** Specifies list of product ids to remove. */ productsToRemove?: Maybe>; /** Specifies list of product variant ids to add. */ productVariantsToAdd?: Maybe>; /** Specifies list of product variant ids to remove. */ productVariantsToRemove?: Maybe>; }; /** The prerequisite purchase amount required for the discount to be applicable. */ export type DiscountPurchaseAmount = { __typename?: 'DiscountPurchaseAmount'; /** Decimal money amount. */ amount: Scalars['Decimal']; }; /** The quantity of items in discount. */ export type DiscountQuantity = { __typename?: 'DiscountQuantity'; /** The quantity of items. */ quantity: Scalars['UnsignedInt64']; }; /** A redeem code for a code discount. */ export type DiscountRedeemCode = { __typename?: 'DiscountRedeemCode'; /** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */ asyncUsageCount: Scalars['Int']; /** The code of a discount. */ code: Scalars['String']; /** The application that created the discount code. */ createdBy?: Maybe; /** Globally unique identifier of the discount redeem code. */ id: Scalars['ID']; }; /** Return type for `discountRedeemCodeBulkAdd` mutation. */ export type DiscountRedeemCodeBulkAddPayload = { __typename?: 'DiscountRedeemCodeBulkAddPayload'; /** Tracks the progress of the bulk code creation. */ bulkCreation?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a bulk creation of discount redeem codes. */ export type DiscountRedeemCodeBulkCreation = Node & { __typename?: 'DiscountRedeemCodeBulkCreation'; /** The codes associated with the bulk creation. */ codes: DiscountRedeemCodeBulkCreationCodeConnection; /** The number of codes to create. */ codesCount: Scalars['Int']; /** The date and time when the bulk creation was created. */ createdAt: Scalars['DateTime']; /** The code discount associated with the created codes. */ discountCode?: Maybe; /** Whether the bulk creation is still queued (`false`) or has been run (`true`). */ done: Scalars['Boolean']; /** The number of codes that weren't created successfully. */ failedCount: Scalars['Int']; /** Globally unique identifier. */ id: Scalars['ID']; /** The number of codes created successfully. */ importedCount: Scalars['Int']; }; /** Represents a bulk creation of discount redeem codes. */ export type DiscountRedeemCodeBulkCreationCodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a discount redeem code created by a bulk creation. */ export type DiscountRedeemCodeBulkCreationCode = { __typename?: 'DiscountRedeemCodeBulkCreationCode'; /** The code of a discount that is sent for creation. */ code: Scalars['String']; /** * The discount redeem code of the successfully created code. * * If the code cannot be created, the field will be null. */ discountRedeemCode?: Maybe; /** A list of errors during the creation process of the code. */ errors: Array; }; /** An auto-generated type for paginating through multiple DiscountRedeemCodeBulkCreationCodes. */ export type DiscountRedeemCodeBulkCreationCodeConnection = { __typename?: 'DiscountRedeemCodeBulkCreationCodeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DiscountRedeemCodeBulkCreationCode and a cursor during pagination. */ export type DiscountRedeemCodeBulkCreationCodeEdge = { __typename?: 'DiscountRedeemCodeBulkCreationCodeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DiscountRedeemCodeBulkCreationCodeEdge. */ node: DiscountRedeemCodeBulkCreationCode; }; /** An auto-generated type for paginating through multiple DiscountRedeemCodes. */ export type DiscountRedeemCodeConnection = { __typename?: 'DiscountRedeemCodeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DiscountRedeemCode and a cursor during pagination. */ export type DiscountRedeemCodeEdge = { __typename?: 'DiscountRedeemCodeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DiscountRedeemCodeEdge. */ node: DiscountRedeemCode; }; /** Specifies the code attached to a discount. */ export type DiscountRedeemCodeInput = { /** The code of a discount. */ code: Scalars['String']; }; /** The shareable URL for the discount code. */ export type DiscountShareableUrl = { __typename?: 'DiscountShareableUrl'; /** The image URL of the item (product or collection) to which the discount applies. */ targetItemImage?: Maybe; /** The type of page that's associated with the URL. */ targetType: DiscountShareableUrlTargetType; /** The title of the page that's associated with the URL. */ title: Scalars['String']; /** The URL for the discount code. */ url: Scalars['URL']; }; /** The page type where shareable URL lands. */ export enum DiscountShareableUrlTargetType { /** The home page type. */ Home = 'HOME', /** The product page type. */ Product = 'PRODUCT', /** The collection page type. */ Collection = 'COLLECTION' } /** The selection of shipping countries to which this discount applies. */ export type DiscountShippingDestinationSelection = DiscountCountries | DiscountCountryAll; /** Specifies the destinations where the free shipping discount will be applied. */ export type DiscountShippingDestinationSelectionInput = { /** Whether the discount code applies to all countries. */ all?: Maybe; /** A list of countries where the discount code will apply. */ countries?: Maybe; }; /** The status of the discount. */ export enum DiscountStatus { /** The discount is active. */ Active = 'ACTIVE', /** The discount is expired. */ Expired = 'EXPIRED', /** The discount is scheduled. */ Scheduled = 'SCHEDULED' } /** The type of line a subscription discount is applied on. */ export enum DiscountTargetType { /** Line item. */ LineItem = 'LINE_ITEM', /** Shipping line. */ ShippingLine = 'SHIPPING_LINE' } /** The original type of the discount. */ export enum DiscountType { /** Manual discount type. */ Manual = 'MANUAL', /** Code discount type. */ CodeDiscount = 'CODE_DISCOUNT' } /** An error that occurs during the execution of a discount mutation. */ export type DiscountUserError = DisplayableError & { __typename?: 'DiscountUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Extra information about this error. */ extraInfo?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Represents an error in the input of a mutation. */ export type DisplayableError = { /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** The possible statuses of a dispute. */ export enum DisputeStatus { NeedsResponse = 'NEEDS_RESPONSE', UnderReview = 'UNDER_REVIEW', ChargeRefunded = 'CHARGE_REFUNDED', Accepted = 'ACCEPTED', Won = 'WON', Lost = 'LOST' } /** The possible types for a dispute. */ export enum DisputeType { /** The dispute has turned into a chargeback. */ Chargeback = 'CHARGEBACK', /** The dispute is in the inquiry phase. */ Inquiry = 'INQUIRY' } /** A unique string that represents the address of a Shopify store on the Internet. */ export type Domain = Node & { __typename?: 'Domain'; /** The host name of the domain (eg: `example.com`). */ host: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The localization of the domain, if it does not redirect. */ localization?: Maybe; /** Whether SSL is enabled or not. */ sslEnabled: Scalars['Boolean']; /** The URL of the domain (eg: `https://example.com`). */ url: Scalars['URL']; }; /** The country and language settings assigned to a domain. */ export type DomainLocalization = { __typename?: 'DomainLocalization'; /** The ISO codes for the domain’s alternate locales. */ alternateLocales: Array; /** The ISO code for the country assigned to the domain, or "*" for a domain set to "Rest of world". */ country?: Maybe; /** The ISO code for the domain’s default locale. */ defaultLocale: Scalars['String']; }; /** Returns unfulfilled line items grouped by their fulfillment service. Each draft fulfillment contains additional information, such as whether the fulfillment requires shipping and whether a shipping label can be printed for it. */ export type DraftFulfillment = { __typename?: 'DraftFulfillment'; /** Whether a label can be purchased. */ allowLabelPurchase: Scalars['Boolean']; /** The line items (which might correspond to a variant) that are part of this draft fulfillment. */ lineItems: Array; /** Whether a fulfillment requires shipping. */ requiresShipping: Scalars['Boolean']; /** The service responsible for fulfilling the fulfillment. */ service: FulfillmentService; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrder = Node & HasMetafields & CommentEventSubject & LegacyInteroperability & HasEvents & HasLocalizationExtensionsForDraftOrders & { __typename?: 'DraftOrder'; /** Order-level discount applied to the draft order. */ appliedDiscount?: Maybe; /** The billing address of the customer. */ billingAddress?: Maybe; /** * Date and time when the draft order converted to a new order, * and the draft order's status changed to **Completed**. */ completedAt?: Maybe; /** Date and time when the draft order was created in Shopify. */ createdAt: Scalars['DateTime']; /** Three letter code for the currency of the store at the time that the invoice is sent. */ currencyCode: CurrencyCode; /** Custom information added to the draft order on behalf of your customer. */ customAttributes: Array; /** Customer who will be sent an invoice for the draft order, if there is one. */ customer?: Maybe; /** Email address of the customer, which is used to send notifications to. */ email?: Maybe; /** List of events associated with the draft order. */ events: EventConnection; /** Whether the merchant has added timeline comments to the draft order. */ hasTimelineComment: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** Date and time when the invoice was last emailed to the customer. */ invoiceSentAt?: Maybe; /** Link to the checkout, which is sent to your customer in the invoice email. */ invoiceUrl?: Maybe; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** List of the line items in the draft order. */ lineItems: DraftOrderLineItemConnection; /** List of localization extensions for the resource. */ localizationExtensions: LocalizationExtensionConnection; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** Unique identifier for the draft order, which is unique within the store. For example, _#D1223_. */ name: Scalars['String']; /** Text from an optional note attached to the draft order. */ note2?: Maybe; /** Order that was created from this draft order. */ order?: Maybe; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** * Whether or not the Draft Order is ready and can be completed. Draft Orders * may have asynchronous operations that can take time to finish. */ ready: Scalars['Boolean']; /** The shipping address of the customer. */ shippingAddress?: Maybe; /** Line item that contains the shipping costs. */ shippingLine?: Maybe; /** Status of the draft order. */ status: DraftOrderStatus; /** Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes). */ subtotalPrice: Scalars['Money']; /** * A comma separated list of tags associated with the draft order. Updating `tags` overwrites * any existing tags that were previously added to the draft order. To add new tags without overwriting * existing tags, use the [tagsAdd](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/tagsadd) * mutation. */ tags: Array; /** Whether the draft order is tax exempt. */ taxExempt: Scalars['Boolean']; /** Total amount of taxes charged for each line item and shipping line. */ taxLines: Array; /** Whether the line item prices include taxes. */ taxesIncluded: Scalars['Boolean']; /** Total amount of the draft order (includes taxes, shipping charges, and discounts). */ totalPrice: Scalars['Money']; /** Total shipping charge for the draft order. */ totalShippingPrice: Scalars['Money']; /** Total amount of taxes for the draft order. */ totalTax: Scalars['Money']; /** Total weight (grams) of the draft order. */ totalWeight: Scalars['UnsignedInt64']; /** * Date and time when the draft order was last changed. * The format is YYYY-MM-DD HH:mm:ss (for example, 2016-02-05 17:04:01). */ updatedAt: Scalars['DateTime']; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrderEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrderLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrderLocalizationExtensionsArgs = { countryCodes?: Maybe>; purposes?: Maybe>; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrderMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrderMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrderPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers. */ export type DraftOrderPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The order-level discount applied to a draft order. */ export type DraftOrderAppliedDiscount = { __typename?: 'DraftOrderAppliedDiscount'; /** * Amount of the order-level discount that is applied to the draft order. * @deprecated Use `amountV2` instead */ amount: Scalars['Money']; /** Amount of money discounted. */ amountV2: MoneyV2; /** Description of the order-level discount. */ description: Scalars['String']; /** Name of the order-level discount. */ title?: Maybe; /** * Amount of the order level discount (when value_type is percentage, * the value in this field is the percentage discount). */ value: Scalars['Float']; /** Type of the order-level discount. */ valueType: DraftOrderAppliedDiscountType; }; /** The input fields for applying an order-level discount to a draft order. */ export type DraftOrderAppliedDiscountInput = { /** The applied amount of the discount. */ amount?: Maybe; /** Reason for the discount. */ description?: Maybe; /** Title of the discount. */ title?: Maybe; /** * The value of the discount. * If the type of the discount is fixed amount, then this is a fixed dollar amount. * If the type is percentage, then this is the percentage. */ value: Scalars['Float']; /** The type of discount. */ valueType: DraftOrderAppliedDiscountType; }; /** The valid discount types that can be applied to a draft order. */ export enum DraftOrderAppliedDiscountType { /** A fixed amount in the store's currency. */ FixedAmount = 'FIXED_AMOUNT', /** A percentage of the order subtotal. */ Percentage = 'PERCENTAGE' } /** Return type for `draftOrderCalculate` mutation. */ export type DraftOrderCalculatePayload = { __typename?: 'DraftOrderCalculatePayload'; /** The calculated properties for a draft order. */ calculatedDraftOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `draftOrderComplete` mutation. */ export type DraftOrderCompletePayload = { __typename?: 'DraftOrderCompletePayload'; /** The completed draft order. */ draftOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple DraftOrders. */ export type DraftOrderConnection = { __typename?: 'DraftOrderConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `draftOrderCreate` mutation. */ export type DraftOrderCreatePayload = { __typename?: 'DraftOrderCreatePayload'; /** The created draft order. */ draftOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the draft order to delete by its ID. */ export type DraftOrderDeleteInput = { /** The ID of the draft order to delete. */ id: Scalars['ID']; }; /** Return type for `draftOrderDelete` mutation. */ export type DraftOrderDeletePayload = { __typename?: 'DraftOrderDeletePayload'; /** The ID of the deleted draft order. */ deletedId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one DraftOrder and a cursor during pagination. */ export type DraftOrderEdge = { __typename?: 'DraftOrderEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DraftOrderEdge. */ node: DraftOrder; }; /** The input fields used to create or update a draft order. */ export type DraftOrderInput = { /** * The discount that will be applied to the draft order. * A draft order line item can have one discount. A draft order can also have one order-level discount. */ appliedDiscount?: Maybe; /** The mailing address associated with the payment method. */ billingAddress?: Maybe; /** Customer associated with the draft order. */ customerId?: Maybe; /** Extra information added to the customer. */ customAttributes?: Maybe>; /** The customer's email address. */ email?: Maybe; /** * Product variant line item or custom line item associated to the draft order. * Each draft order must include at least one line item. */ lineItems?: Maybe>; /** Metafields attached to the draft order. */ metafields?: Maybe>; /** The private metafields attached to the draft order. */ privateMetafields?: Maybe>; /** The localization extensions attached to the draft order. For example, Tax IDs. */ localizationExtensions?: Maybe>; /** The text of an optional note that a shop owner can attach to the draft order. */ note?: Maybe; /** The mailing address to where the order will be shipped. */ shippingAddress?: Maybe; /** A shipping line object, which details the shipping method used. */ shippingLine?: Maybe; /** A comma separated list of tags that have been added to the draft order. */ tags?: Maybe>; /** * Whether or not taxes are exempt for the draft order. * If false, then Shopify will refer to the taxable field for each line item. * If a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead. */ taxExempt?: Maybe; /** Sent as part of a draft order object to load customer shipping information. */ useCustomerDefaultAddress?: Maybe; }; /** Return type for `draftOrderInvoicePreview` mutation. */ export type DraftOrderInvoicePreviewPayload = { __typename?: 'DraftOrderInvoicePreviewPayload'; /** HTML to preview the draft order invoice email. */ previewHtml?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `draftOrderInvoiceSend` mutation. */ export type DraftOrderInvoiceSendPayload = { __typename?: 'DraftOrderInvoiceSendPayload'; /** The draft order an invoice email is sent for. */ draftOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a line item included in a draft order. */ export type DraftOrderLineItem = Node & { __typename?: 'DraftOrderLineItem'; /** Discount which will be applied to the line item or the overall order. */ appliedDiscount?: Maybe; /** * Whether this is a product variant line item, or a custom line item. * If set to true indicates a custom line item. If set to false indicates a product variant line item. */ custom: Scalars['Boolean']; /** List of additional information (metafields) about the line item. */ customAttributes: Array; /** Line item price after discounts are applied. */ discountedTotal: Scalars['Money']; /** The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit. */ discountedUnitPrice: Scalars['Money']; /** * Name of the service provider who fulfilled the order. * * Valid values are either **manual** or the name of the provider. * For example, **amazon**, **shipwire**. */ fulfillmentService: FulfillmentService; /** * Weight in grams. Can only be specified if this is a custom line item. * @deprecated Use `weight` instead */ grams?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** Image associated with the draft order line item. */ image?: Maybe; /** Whether the line item represents the puchase of a gift card. */ isGiftCard: Scalars['Boolean']; /** Name of the product. */ name: Scalars['String']; /** Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. */ originalTotal: Scalars['Money']; /** Variant price without any discounts applied. */ originalUnitPrice: Scalars['Money']; /** The product corresponding to the line item’s product variant. */ product?: Maybe; /** Number of variant items requested in the draft order. */ quantity: Scalars['Int']; /** Whether physical shipping is required for the variant. */ requiresShipping: Scalars['Boolean']; /** Variant SKU number. */ sku?: Maybe; /** A list of tax line objects, each of which details the total taxes applicable to the order. */ taxLines: Array; /** Whether the variant is taxable. */ taxable: Scalars['Boolean']; /** Title of the product or variant (this field only applies to custom line items). */ title: Scalars['String']; /** Total value of the discount applied to the line item. */ totalDiscount: Scalars['Money']; /** Associated variant for the line item. */ variant?: Maybe; /** Name of the variant. */ variantTitle?: Maybe; /** Name of the vendor who made the variant. */ vendor?: Maybe; /** Weight unit and value for a draft order line item. */ weight?: Maybe; }; /** Represents a line item included in a draft order. */ export type DraftOrderLineItemImageArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** An auto-generated type for paginating through multiple DraftOrderLineItems. */ export type DraftOrderLineItemConnection = { __typename?: 'DraftOrderLineItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination. */ export type DraftOrderLineItemEdge = { __typename?: 'DraftOrderLineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of DraftOrderLineItemEdge. */ node: DraftOrderLineItem; }; /** The input fields used to create a line item for a draft order. */ export type DraftOrderLineItemInput = { /** Discount which will be applied to the line item. */ appliedDiscount?: Maybe; /** Represents a generic custom attribute using a key value pair. */ customAttributes?: Maybe>; /** Ignored when variant ID is provided. This argument is deprecated: Use `weight` instead. */ grams?: Maybe; /** Ignored when variant ID is provided. */ originalUnitPrice?: Maybe; /** The number of products that were purchased. */ quantity: Scalars['Int']; /** Ignored when variant ID is provided. */ requiresShipping?: Maybe; /** Ignored when variant ID is provided. */ sku?: Maybe; /** Ignored when variant ID is provided. */ taxable?: Maybe; /** Ignored when variant ID is provided. */ title?: Maybe; /** * The ID of the product variant corresponding to the line item. * Null if custom line item. Required if product variant line item. */ variantId?: Maybe; /** * Specifies the weight unit and value inputs. * Ignored when variant ID is provided. */ weight?: Maybe; }; /** The set of valid sort keys for the DraftOrder query. */ export enum DraftOrderSortKeys { /** Sort by the `number` value. */ Number = 'NUMBER', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `status` value. */ Status = 'STATUS', /** Sort by the `total_price` value. */ TotalPrice = 'TOTAL_PRICE', /** Sort by the `customer_name` value. */ CustomerName = 'CUSTOMER_NAME', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The valid statuses for a draft order. */ export enum DraftOrderStatus { /** The draft order has been paid. */ Completed = 'COMPLETED', /** An invoice for the draft order has been sent to the customer. */ InvoiceSent = 'INVOICE_SENT', /** The draft order is open. It has not been paid, and an invoice hasn't been sent. */ Open = 'OPEN' } /** Return type for `draftOrderUpdate` mutation. */ export type DraftOrderUpdatePayload = { __typename?: 'DraftOrderUpdatePayload'; /** The updated draft order. */ draftOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a single duty for a line item. */ export type Duty = Node & { __typename?: 'Duty'; /** The ISO code of the country of origin of the line item. */ countryCodeOfOrigin?: Maybe; /** The harmonized system code of the line item. */ harmonizedSystemCode?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The price of the duty for the line item. */ price: MoneyBag; /** The TaxLine objects connected to the duty for the line item. */ taxLines: Array; }; /** The attribute editable information. */ export type EditableProperty = { __typename?: 'EditableProperty'; /** Whether the attribute is locked for editing. */ locked: Scalars['Boolean']; /** The reason the attribute is locked for editing. */ reason?: Maybe; }; /** Specifies the fields for an email. */ export type EmailInput = { /** Specifies the email subject. */ subject?: Maybe; /** Specifies the email recipient. */ to?: Maybe; /** Specifies the email sender. */ from?: Maybe; /** Specifies the email body. */ body?: Maybe; /** Specifies any bcc recipients for the email. */ bcc?: Maybe>; /** Specifies a custom message to include in the email. */ customMessage?: Maybe; }; /** * Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the * addition of a product. */ export type Event = { /** The name of the app that created the event. Returns null when the event originates from the Shopify admin. */ appTitle?: Maybe; /** Whether the event was created by an app. */ attributeToApp: Scalars['Boolean']; /** Whether the event was caused by an admin user. */ attributeToUser: Scalars['Boolean']; /** The date and time when the event was created. */ createdAt: Scalars['DateTime']; /** Whether the event is critical. */ criticalAlert: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** Human readable text that describes the event. */ message: Scalars['FormattedString']; }; /** Return type for `eventBridgeWebhookSubscriptionCreate` mutation. */ export type EventBridgeWebhookSubscriptionCreatePayload = { __typename?: 'EventBridgeWebhookSubscriptionCreatePayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; /** The webhook subscription that was created. */ webhookSubscription?: Maybe; }; /** Specifies the input fields for an EventBridge webhook subscription. */ export type EventBridgeWebhookSubscriptionInput = { /** ARN of the EventBridge event source. */ arn?: Maybe; /** The format in which the webhook subscription should send the data. */ format?: Maybe; /** The list of fields to be included in the webhook subscription. */ includeFields?: Maybe>; /** The list of namespaces for any metafields that should be included in the webhook subscription. */ metafieldNamespaces?: Maybe>; }; /** Return type for `eventBridgeWebhookSubscriptionUpdate` mutation. */ export type EventBridgeWebhookSubscriptionUpdatePayload = { __typename?: 'EventBridgeWebhookSubscriptionUpdatePayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; /** The webhook subscription that was updated. */ webhookSubscription?: Maybe; }; /** An auto-generated type for paginating through multiple Events. */ export type EventConnection = { __typename?: 'EventConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one Event and a cursor during pagination. */ export type EventEdge = { __typename?: 'EventEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of EventEdge. */ node: Event; }; /** The set of valid sort keys for the Event query. */ export enum EventSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Represents a video hosted outside of Shopify. */ export type ExternalVideo = Node & Media & { __typename?: 'ExternalVideo'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** The URL. */ embeddedUrl: Scalars['URL']; /** The host of the external video. */ host: MediaHost; /** Globally unique identifier. */ id: Scalars['ID']; /** The media content type. */ mediaContentType: MediaContentType; /** Any errors which have occurred on the media. */ mediaErrors: Array; /** The preview image for the media. */ preview?: Maybe; /** Current status of the media. */ status: MediaStatus; }; /** Requirements that must be met before an app can be installed. */ export type FailedRequirement = { __typename?: 'FailedRequirement'; /** Action to be taken to resolve a failed requirement, including URL link. */ action?: Maybe; /** * A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app * encounters when trying to make use of their Shop and its resources. */ message: Scalars['String']; }; /** A filter option is one possible value in a search filter. */ export type FilterOption = { __typename?: 'FilterOption'; /** The filter option's label for display purposes. */ label: Scalars['String']; /** The filter option's value. */ value: Scalars['String']; }; /** Return type for `flowTriggerReceive` mutation. */ export type FlowTriggerReceivePayload = { __typename?: 'FlowTriggerReceivePayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order. */ export type Fulfillment = LegacyInteroperability & Node & { __typename?: 'Fulfillment'; /** The date and time when the fulfillment was created. */ createdAt: Scalars['DateTime']; /** The date that this fulfillment was delivered. */ deliveredAt?: Maybe; /** Human readable display status for this fulfillment. */ displayStatus?: Maybe; /** The estimated date that this fulfillment will arrive. */ estimatedDeliveryAt?: Maybe; /** The history of events associated with this fulfillment. */ events: FulfillmentEventConnection; /** List of the fulfillment's line items. */ fulfillmentLineItems: FulfillmentLineItemConnection; /** A list of fulfillment orders for the fulfillment. */ fulfillmentOrders: FulfillmentOrderConnection; /** Globally unique identifier. */ id: Scalars['ID']; /** The date and time when the fulfillment went into transit. */ inTransitAt?: Maybe; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The location that the fulfillment was processed at. */ location?: Maybe; /** Human readable reference identifier for this fulfillment. */ name: Scalars['String']; /** The order for which the fulfillment was created. */ order: Order; /** Whether any of the line items in the fulfillment require shipping. */ requiresShipping: Scalars['Boolean']; /** Fulfillment service associated with the fulfillment. */ service?: Maybe; /** The status of the fulfillment. */ status: FulfillmentStatus; /** Sum of all line item quantities for the fulfillment. */ totalQuantity: Scalars['Int']; /** * Tracking information associated with the fulfillment, * such as the tracking company, tracking number, and tracking URL. */ trackingInfo: Array; /** The date and time when the fulfillment was last modified. */ updatedAt: Scalars['DateTime']; }; /** Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order. */ export type FulfillmentEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order. */ export type FulfillmentFulfillmentLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order. */ export type FulfillmentFulfillmentOrdersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order. */ export type FulfillmentTrackingInfoArgs = { first?: Maybe; }; /** Return type for `fulfillmentCancel` mutation. */ export type FulfillmentCancelPayload = { __typename?: 'FulfillmentCancelPayload'; /** The canceled fulfillment. */ fulfillment?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple Fulfillments. */ export type FulfillmentConnection = { __typename?: 'FulfillmentConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `fulfillmentCreate` mutation. */ export type FulfillmentCreatePayload = { __typename?: 'FulfillmentCreatePayload'; /** The created fulfillment. */ fulfillment?: Maybe; /** The order for which the fulfillment is created. */ order?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentCreateV2` mutation. */ export type FulfillmentCreateV2Payload = { __typename?: 'FulfillmentCreateV2Payload'; /** The created fulfillment. */ fulfillment?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The display status of a fulfillment. */ export enum FulfillmentDisplayStatus { /** Displayed as **Attempted delivery**. */ AttemptedDelivery = 'ATTEMPTED_DELIVERY', /** Displayed as **Canceled**. */ Canceled = 'CANCELED', /** Displayed as **Confirmed**. */ Confirmed = 'CONFIRMED', /** Displayed as **Delivered**. */ Delivered = 'DELIVERED', /** Displayed as **Failure**. */ Failure = 'FAILURE', /** Displayed as **Fulfilled**. */ Fulfilled = 'FULFILLED', /** Displayed as **In transit**. */ InTransit = 'IN_TRANSIT', /** Displayed as **Label printed**. */ LabelPrinted = 'LABEL_PRINTED', /** Displayed as **Label purchased**. */ LabelPurchased = 'LABEL_PURCHASED', /** Displayed as **Label voided**. */ LabelVoided = 'LABEL_VOIDED', /** Displayed as **Marked as fulfilled**. */ MarkedAsFulfilled = 'MARKED_AS_FULFILLED', /** Displayed as **Not delivered**. */ NotDelivered = 'NOT_DELIVERED', /** Displayed as **Out for delivery**. */ OutForDelivery = 'OUT_FOR_DELIVERY', /** Displayed as **Ready for pickup**. */ ReadyForPickup = 'READY_FOR_PICKUP', /** Displayed as **Picked up**. */ PickedUp = 'PICKED_UP', /** Displayed as **Submitted**. */ Submitted = 'SUBMITTED' } /** An auto-generated type which holds one Fulfillment and a cursor during pagination. */ export type FulfillmentEdge = { __typename?: 'FulfillmentEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentEdge. */ node: Fulfillment; }; /** An event that describes a fulfillment at a time. */ export type FulfillmentEvent = Node & { __typename?: 'FulfillmentEvent'; /** The time at which this fulfillment event happened. */ happenedAt: Scalars['DateTime']; /** Globally unique identifier. */ id: Scalars['ID']; /** The status of this fulfillment event. */ status: FulfillmentEventStatus; }; /** An auto-generated type for paginating through multiple FulfillmentEvents. */ export type FulfillmentEventConnection = { __typename?: 'FulfillmentEventConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one FulfillmentEvent and a cursor during pagination. */ export type FulfillmentEventEdge = { __typename?: 'FulfillmentEventEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentEventEdge. */ node: FulfillmentEvent; }; /** The set of valid sort keys for the FulfillmentEvent query. */ export enum FulfillmentEventSortKeys { /** Sort by the `happened_at` value. */ HappenedAt = 'HAPPENED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Event status' describe the status of a fulfillment. */ export enum FulfillmentEventStatus { /** A shipping label has been purchased. */ LabelPurchased = 'LABEL_PURCHASED', /** A purchased shipping label has been printed. */ LabelPrinted = 'LABEL_PRINTED', /** The fulfillment is ready to be picked up. */ ReadyForPickup = 'READY_FOR_PICKUP', /** The fulfillment is confirmed. */ Confirmed = 'CONFIRMED', /** The fulfillment is in transit. */ InTransit = 'IN_TRANSIT', /** The fulfillment is out for delivery. */ OutForDelivery = 'OUT_FOR_DELIVERY', /** A delivery was attempted. */ AttemptedDelivery = 'ATTEMPTED_DELIVERY', /** The fulfillment was successfully delivered. */ Delivered = 'DELIVERED', /** The fulfillment request failed. */ Failure = 'FAILURE' } /** The input fields used to create a fulfillment. */ export type FulfillmentInput = { /** The ID of the order to be fulfilled. */ orderId: Scalars['ID']; /** The line items to be fulfilled. */ lineItems?: Maybe>; /** Tracking numbers associated with the fulfillment. */ trackingNumbers?: Maybe>; /** The URLs to track the fulfillment. */ trackingUrls?: Maybe>; /** The name of the tracking company. */ trackingCompany?: Maybe; /** * Whether the customer is notified. * If set to true, a notification is sent when the fulfillment is created. */ notifyCustomer?: Maybe; /** A reference to the shipping method, such as `Free Shipping`. */ shippingMethod?: Maybe; /** The ID of the location from which the items will be fulfilled. */ locationId: Scalars['ID']; }; /** Represents a line item from an order that's included in a fulfillment. */ export type FulfillmentLineItem = Node & { __typename?: 'FulfillmentLineItem'; /** * The total price after discounts are applied. * @deprecated Use `discountedTotalSet` instead */ discountedTotal: Scalars['Money']; /** The total price after discounts are applied in shop and presentment currencies. */ discountedTotalSet: MoneyBag; /** Globally unique identifier. */ id: Scalars['ID']; /** The associated order's line item. */ lineItem: LineItem; /** * The total price before discounts are applied. * @deprecated Use `originalTotalSet` instead */ originalTotal: Scalars['Money']; /** The total price before discounts are applied in shop and presentment currencies. */ originalTotalSet: MoneyBag; /** Number of line items in the fulfillment. */ quantity?: Maybe; }; /** An auto-generated type for paginating through multiple FulfillmentLineItems. */ export type FulfillmentLineItemConnection = { __typename?: 'FulfillmentLineItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. */ export type FulfillmentLineItemEdge = { __typename?: 'FulfillmentLineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentLineItemEdge. */ node: FulfillmentLineItem; }; /** The input fields used to include a line item from an order in a fulfillment. */ export type FulfillmentLineItemInput = { /** The ID of the line item. */ id: Scalars['ID']; /** The quantity of the line item to be fulfilled. */ quantity?: Maybe; }; /** * Represents a fulfillment order. In Shopify, a fulfillment order represents a group of one or more items * in an order that are to be fulfilled from the same location. There can be more than one fulfillment order * for an order at a given location. */ export type FulfillmentOrder = Node & { __typename?: 'FulfillmentOrder'; /** The fulfillment order's assigned location. This is the location expected to perform fulfillment. */ assignedLocation: FulfillmentOrderAssignedLocation; /** Delivery method of this fulfillment order. */ deliveryMethod?: Maybe; /** The destination where the items should be sent. */ destination?: Maybe; /** The date and time at which the fulfillment order will be fulfillable. */ fulfillAt?: Maybe; /** A list of fulfillments for the fulfillment order. */ fulfillments: FulfillmentConnection; /** Globally unique identifier. */ id: Scalars['ID']; /** A list of the fulfillment order's line items. */ lineItems: FulfillmentOrderLineItemConnection; /** A list of locations that the fulfillment order can potentially move to. */ locationsForMove: FulfillmentOrderLocationForMoveConnection; /** A list of requests sent by the merchant to the fulfillment service for this fulfillment order. */ merchantRequests: FulfillmentOrderMerchantRequestConnection; /** The order that's associated with the fulfillment order. */ order: Order; /** The request status of the fulfillment order. */ requestStatus: FulfillmentOrderRequestStatus; /** The status of the fulfillment order. */ status: FulfillmentOrderStatus; /** The actions that can be performed on this fulfillment order. */ supportedActions: Array; }; /** * Represents a fulfillment order. In Shopify, a fulfillment order represents a group of one or more items * in an order that are to be fulfilled from the same location. There can be more than one fulfillment order * for an order at a given location. */ export type FulfillmentOrderFulfillmentsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a fulfillment order. In Shopify, a fulfillment order represents a group of one or more items * in an order that are to be fulfilled from the same location. There can be more than one fulfillment order * for an order at a given location. */ export type FulfillmentOrderLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a fulfillment order. In Shopify, a fulfillment order represents a group of one or more items * in an order that are to be fulfilled from the same location. There can be more than one fulfillment order * for an order at a given location. */ export type FulfillmentOrderLocationsForMoveArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a fulfillment order. In Shopify, a fulfillment order represents a group of one or more items * in an order that are to be fulfilled from the same location. There can be more than one fulfillment order * for an order at a given location. */ export type FulfillmentOrderMerchantRequestsArgs = { kind?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Return type for `fulfillmentOrderAcceptCancellationRequest` mutation. */ export type FulfillmentOrderAcceptCancellationRequestPayload = { __typename?: 'FulfillmentOrderAcceptCancellationRequestPayload'; /** The fulfillment order whose cancellation request was accepted. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentOrderAcceptFulfillmentRequest` mutation. */ export type FulfillmentOrderAcceptFulfillmentRequestPayload = { __typename?: 'FulfillmentOrderAcceptFulfillmentRequestPayload'; /** The fulfillment order whose fulfillment request was accepted. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The actions that can be taken on a fulfillment order. */ export enum FulfillmentOrderAction { /** Create a fulfillment for selected line items in the fulfillment order. The corresponding mutation for this action is FulfillmentCreateV2. */ CreateFulfillment = 'CREATE_FULFILLMENT', /** Send a request for fulfilling selected line items in a fulfillment order to a fulfillment service. The corresponding mutation for this action is FulfillmentOrderSubmitFulfillmentRequest. */ RequestFulfillment = 'REQUEST_FULFILLMENT', /** Cancel a fulfillment order. The corresponding mutation for this action is FulfillmentOrderCancel. */ CancelFulfillmentOrder = 'CANCEL_FULFILLMENT_ORDER', /** Move a fulfillment order. The corresponding mutation for this action is FulfillmentOrderMove. */ Move = 'MOVE', /** Send a cancellation request to the fulfillment service of a fulfillment order. The corresponding mutation for this action is FulfillmentOrderSubmitCancellationRequest. */ RequestCancellation = 'REQUEST_CANCELLATION', /** Mark the fulfillment order as open. */ MarkAsOpen = 'MARK_AS_OPEN', /** Open an external URL to initiate the fulfillment process outside Shopify. */ External = 'EXTERNAL' } /** * Represents the assigned location of a fulfillment order, which is a snapshot of the location * at which the fulfillment order was created. The assigned location is expected to perform fulfillment. */ export type FulfillmentOrderAssignedLocation = { __typename?: 'FulfillmentOrderAssignedLocation'; /** 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 two-letter country code of the location. */ countryCode: CountryCode; /** * The location where the fulfillment order was created. This can differ from the * `FulfillmentOrderAssignedLocation` if the location was updated since the fulfillment order * was closed. */ location?: Maybe; /** The name of the location. */ name: Scalars['String']; /** The phone number of the location. */ phone?: Maybe; /** The province of the location. */ province?: Maybe; /** The ZIP code of the location. */ zip?: Maybe; }; /** The assigment status to be used to filter fulfillment orders. */ export enum FulfillmentOrderAssignmentStatus { /** * Fulfillment orders for which the merchant has requested cancellation of * the previously accepted fulfillment request. */ CancellationRequested = 'CANCELLATION_REQUESTED', /** Fulfillment orders for which the merchant has requested fulfillment. */ FulfillmentRequested = 'FULFILLMENT_REQUESTED', /** * Fulfillment orders for which the merchant's fulfillment request has been accepted. * Any number of fulfillments can be created on these fulfillment orders * to completely fulfill the requested items. */ FulfillmentAccepted = 'FULFILLMENT_ACCEPTED' } /** Return type for `fulfillmentOrderCancel` mutation. */ export type FulfillmentOrderCancelPayload = { __typename?: 'FulfillmentOrderCancelPayload'; /** The fulfillment order that was marked as canceled. */ fulfillmentOrder?: Maybe; /** The fulfillment order that was created to replace the canceled fulfillment order. */ replacementFulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentOrderClose` mutation. */ export type FulfillmentOrderClosePayload = { __typename?: 'FulfillmentOrderClosePayload'; /** The fulfillment order that was marked as incomplete. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple FulfillmentOrders. */ export type FulfillmentOrderConnection = { __typename?: 'FulfillmentOrderConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Represents the destination where the items should be sent upon fulfillment. */ export type FulfillmentOrderDestination = Node & { __typename?: 'FulfillmentOrderDestination'; /** The first line of the address of the destination. */ address1?: Maybe; /** The second line of the address of the destination. */ address2?: Maybe; /** The city of the destination. */ city?: Maybe; /** The company of the destination. */ company?: Maybe; /** The two-letter country code of the destination. */ countryCode?: Maybe; /** The email of the customer at the destination. */ email?: Maybe; /** The first name of the customer at the destination. */ firstName?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The last name of the customer at the destination. */ lastName?: Maybe; /** The phone number of the customer at the destination. */ phone?: Maybe; /** The province of the destination. */ province?: Maybe; /** The ZIP code of the destination. */ zip?: Maybe; }; /** An auto-generated type which holds one FulfillmentOrder and a cursor during pagination. */ export type FulfillmentOrderEdge = { __typename?: 'FulfillmentOrderEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentOrderEdge. */ node: FulfillmentOrder; }; /** Represents a line item belonging to a fulfillment order. */ export type FulfillmentOrderLineItem = Node & { __typename?: 'FulfillmentOrderLineItem'; /** Globally unique identifier. */ id: Scalars['ID']; /** The associated order line item. */ lineItem: LineItem; /** The number of units remaining to be fulfilled. */ remainingQuantity: Scalars['Int']; /** The total number of units to be fulfilled. */ totalQuantity: Scalars['Int']; }; /** An auto-generated type for paginating through multiple FulfillmentOrderLineItems. */ export type FulfillmentOrderLineItemConnection = { __typename?: 'FulfillmentOrderLineItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one FulfillmentOrderLineItem and a cursor during pagination. */ export type FulfillmentOrderLineItemEdge = { __typename?: 'FulfillmentOrderLineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentOrderLineItemEdge. */ node: FulfillmentOrderLineItem; }; /** The input fields used to include a line item from a fulfillment order. */ export type FulfillmentOrderLineItemInput = { /** The ID of the fulfillment order line item. */ id: Scalars['ID']; /** The quantity of the fulfillment order line item. */ quantity: Scalars['Int']; }; /** The input fields used to include the line items of a specified fulfillment order that should be fulfilled. */ export type FulfillmentOrderLineItemsInput = { /** The ID of the fulfillment order. */ fulfillmentOrderId: Scalars['ID']; /** * The fulfillment order line items to be fulfilled. * If left blank, all line items of the fulfillment order will be fulfilled. */ fulfillmentOrderLineItems?: Maybe>; }; /** A location that a fulfillment order can potentially move to. */ export type FulfillmentOrderLocationForMove = { __typename?: 'FulfillmentOrderLocationForMove'; /** The location being considered as the fulfillment order's new assigned location. */ location: Location; /** * A human-readable string with the reason why the fulfillment order, or some of its line items, can't be * moved to the location. */ message?: Maybe; /** Whether the fulfillment order can be moved to the location. */ movable: Scalars['Boolean']; }; /** An auto-generated type for paginating through multiple FulfillmentOrderLocationForMoves. */ export type FulfillmentOrderLocationForMoveConnection = { __typename?: 'FulfillmentOrderLocationForMoveConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one FulfillmentOrderLocationForMove and a cursor during pagination. */ export type FulfillmentOrderLocationForMoveEdge = { __typename?: 'FulfillmentOrderLocationForMoveEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentOrderLocationForMoveEdge. */ node: FulfillmentOrderLocationForMove; }; /** Represents a request made by the merchant to a fulfillment service for a fulfillment order. */ export type FulfillmentOrderMerchantRequest = Node & { __typename?: 'FulfillmentOrderMerchantRequest'; /** Globally unique identifier. */ id: Scalars['ID']; /** The kind of request made. */ kind: FulfillmentOrderMerchantRequestKind; /** The optional message that the merchant included in the request. */ message?: Maybe; /** * Additional options requested by the merchant. These depend on the `kind` of the request. * For example, for a `FULFILLMENT_REQUEST`, one option is `notify_customer`, which indicates whether the * merchant intends to notify the customer upon fulfillment. The fulfillment service can then set * `notifyCustomer` when making calls to `FulfillmentCreateV2`. */ requestOptions?: Maybe; /** The response from the fulfillment service. */ responseData?: Maybe; /** The timestamp when the request was made. */ sentAt: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple FulfillmentOrderMerchantRequests. */ export type FulfillmentOrderMerchantRequestConnection = { __typename?: 'FulfillmentOrderMerchantRequestConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one FulfillmentOrderMerchantRequest and a cursor during pagination. */ export type FulfillmentOrderMerchantRequestEdge = { __typename?: 'FulfillmentOrderMerchantRequestEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of FulfillmentOrderMerchantRequestEdge. */ node: FulfillmentOrderMerchantRequest; }; /** The kinds of request merchants can make to a fulfillment service. */ export enum FulfillmentOrderMerchantRequestKind { /** The merchant requested fulfillment for a fulfillment order. */ FulfillmentRequest = 'FULFILLMENT_REQUEST', /** The merchant requested cancellation of an accepted or in-progress fulfillment order. */ CancellationRequest = 'CANCELLATION_REQUEST' } /** Return type for `fulfillmentOrderMove` mutation. */ export type FulfillmentOrderMovePayload = { __typename?: 'FulfillmentOrderMovePayload'; /** A new fulfillment order representing all items that were able to be moved to the new location. */ movedFulfillmentOrder?: Maybe; /** The fulfillment order that was moved. On success, this fulfillment order will be closed. */ originalFulfillmentOrder?: Maybe; /** * A new fulfillment order representing any items still assigned to the original location. * This is created if all line items on the original fulfillment order could not be moved to the new location * due to not being stocked there. */ remainingFulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentOrderOpen` mutation. */ export type FulfillmentOrderOpenPayload = { __typename?: 'FulfillmentOrderOpenPayload'; /** The fulfillment order that was marked as open. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentOrderRejectCancellationRequest` mutation. */ export type FulfillmentOrderRejectCancellationRequestPayload = { __typename?: 'FulfillmentOrderRejectCancellationRequestPayload'; /** The fulfillment order whose cancellation request was rejected. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentOrderRejectFulfillmentRequest` mutation. */ export type FulfillmentOrderRejectFulfillmentRequestPayload = { __typename?: 'FulfillmentOrderRejectFulfillmentRequestPayload'; /** The fulfillment order whose fulfillment request was rejected. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The request status of a fulfillment order. */ export enum FulfillmentOrderRequestStatus { /** * The initial request status for the newly created fulfillment orders. This is the only valid * request status for fulfillment orders that aren't assigned to a fulfillment service. */ Unsubmitted = 'UNSUBMITTED', /** The merchant requested fulfillment for this fulfillment order. */ Submitted = 'SUBMITTED', /** The fulfillment service accepted the merchant's fulfillment request. */ Accepted = 'ACCEPTED', /** The fulfillment service rejected the merchant's fulfillment request. */ Rejected = 'REJECTED', /** The merchant requested a cancellation of the fulfillment request for this fulfillment order. */ CancellationRequested = 'CANCELLATION_REQUESTED', /** The fulfillment service accepted the merchant's fulfillment cancellation request. */ CancellationAccepted = 'CANCELLATION_ACCEPTED', /** The fulfillment service rejected the merchant's fulfillment cancellation request. */ CancellationRejected = 'CANCELLATION_REJECTED', /** The fulfillment service closed the fulfillment order without completing it. */ Closed = 'CLOSED' } /** Return type for `fulfillmentOrderReschedule` mutation. */ export type FulfillmentOrderReschedulePayload = { __typename?: 'FulfillmentOrderReschedulePayload'; /** The fulfillment order that was updated to the new fulfill at date. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of FulfillmentOrderReschedule. */ export type FulfillmentOrderRescheduleUserError = DisplayableError & { __typename?: 'FulfillmentOrderRescheduleUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by FulfillmentOrderRescheduleUserError. */ export enum FulfillmentOrderRescheduleUserErrorCode { /** Fulfillment order could not be found. */ FulfillmentOrderNotFound = 'FULFILLMENT_ORDER_NOT_FOUND' } /** The set of valid sort keys for the FulfillmentOrder query. */ export enum FulfillmentOrderSortKeys { /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The status of a fulfillment order. */ export enum FulfillmentOrderStatus { /** The fulfillment order has been opened. */ Open = 'OPEN', /** The fulfillment order is being processed. */ InProgress = 'IN_PROGRESS', /** The fulfillment order has been cancelled by the merchant. */ Cancelled = 'CANCELLED', /** The fulfillment order cannot be completed as requested. */ Incomplete = 'INCOMPLETE', /** The fulfillment order has been completed and closed. */ Closed = 'CLOSED', /** The fulfillment order is scheduled for fulfillment. */ Scheduled = 'SCHEDULED' } /** Return type for `fulfillmentOrderSubmitCancellationRequest` mutation. */ export type FulfillmentOrderSubmitCancellationRequestPayload = { __typename?: 'FulfillmentOrderSubmitCancellationRequestPayload'; /** The fulfillment order whose cancellation was requested. */ fulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentOrderSubmitFulfillmentRequest` mutation. */ export type FulfillmentOrderSubmitFulfillmentRequestPayload = { __typename?: 'FulfillmentOrderSubmitFulfillmentRequestPayload'; /** The original fulfillment order intended to request fulfillment for. */ originalFulfillmentOrder?: Maybe; /** * The fulfillment order that was submitted to the fulfillment service. This will be the same as * the original fulfillment order field. The exception to this is partial fulfillment requests or * fulfillment request for cancelled or incomplete fulfillment orders. */ submittedFulfillmentOrder?: Maybe; /** * This field will only be present for partial fulfillment requests. This will represent the new * fulfillment order with the remaining line items not submitted to the fulfillment service. */ unsubmittedFulfillmentOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents one of the methods that the fulfillment order supports. */ export type FulfillmentOrderSupportedAction = { __typename?: 'FulfillmentOrderSupportedAction'; /** The action value. */ action: FulfillmentOrderAction; /** The external URL to be used to initiate the fulfillment process outside Shopify. */ externalUrl?: Maybe; }; /** Represents a fulfillment service. A fulfillment service is a third-party service that prepares and ships orders on behalf of the store owner. */ export type FulfillmentService = { __typename?: 'FulfillmentService'; /** The callback URL the fulfillment service has registered for requests. */ callbackUrl?: Maybe; /** Whether the fulfillment service has opted into fulfillment order based requests. */ fulfillmentOrdersOptIn: Scalars['Boolean']; /** Human-readable unique identifier for this fulfillment service. */ handle: Scalars['String']; /** The ID of the fulfillment service. */ id: Scalars['ID']; /** Whether the fulfillment service tracks product inventory and provides updates to Shopify. */ inventoryManagement: Scalars['Boolean']; /** Location associated with the fulfillment service. */ location?: Maybe; /** Whether the fulfillment service supports local deliveries. */ productBased: Scalars['Boolean']; /** The name of the fulfillment service as seen by merchants. */ serviceName: Scalars['String']; /** Shipping methods associated with the fulfillment service provider. */ shippingMethods: Array; /** Type associated with the fulfillment service. */ type: FulfillmentServiceType; }; /** Return type for `fulfillmentServiceCreate` mutation. */ export type FulfillmentServiceCreatePayload = { __typename?: 'FulfillmentServiceCreatePayload'; /** The created fulfillment service. */ fulfillmentService?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentServiceDelete` mutation. */ export type FulfillmentServiceDeletePayload = { __typename?: 'FulfillmentServiceDeletePayload'; /** The ID of the deleted fulfillment service. */ deletedId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The type of a fulfillment service. */ export enum FulfillmentServiceType { /** Fulfillment by gift card. */ GiftCard = 'GIFT_CARD', /** Manual fulfillment by the merchant. */ Manual = 'MANUAL', /** Fullfillment by a third-party fulfillment service. */ ThirdParty = 'THIRD_PARTY' } /** Return type for `fulfillmentServiceUpdate` mutation. */ export type FulfillmentServiceUpdatePayload = { __typename?: 'FulfillmentServiceUpdatePayload'; /** The updated fulfillment service. */ fulfillmentService?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The status of a fulfillment. */ export enum FulfillmentStatus { /** Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`. */ Pending = 'PENDING', /** The third-party fulfillment service has acknowledged the fulfilment and is processing it. */ Open = 'OPEN', /** The fulfillment was completed successfully. */ Success = 'SUCCESS', /** The fulfillment was canceled. */ Cancelled = 'CANCELLED', /** There was an error with the fulfillment request. */ Error = 'ERROR', /** The fulfillment request failed. */ Failure = 'FAILURE' } /** Represents the tracking information for a fulfillment. */ export type FulfillmentTrackingInfo = { __typename?: 'FulfillmentTrackingInfo'; /** The name of the tracking company. */ company?: Maybe; /** The tracking number of the fulfillment. */ number?: Maybe; /** The URLs to track the fulfillment. */ url?: Maybe; }; /** Return type for `fulfillmentTrackingInfoUpdate` mutation. */ export type FulfillmentTrackingInfoUpdatePayload = { __typename?: 'FulfillmentTrackingInfoUpdatePayload'; /** The updated fulfillment with tracking information. */ fulfillment?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `fulfillmentTrackingInfoUpdateV2` mutation. */ export type FulfillmentTrackingInfoUpdateV2Payload = { __typename?: 'FulfillmentTrackingInfoUpdateV2Payload'; /** The updated fulfillment with tracking information. */ fulfillment?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The input fields used to specify all possible fields for tracking information. */ export type FulfillmentTrackingInput = { /** The tracking number of the fulfillment. */ number?: Maybe; /** The URL to track the fulfillment. */ url?: Maybe; /** The name of the tracking company. */ company?: Maybe; }; /** The input fields used to create a fulfillment from fulfillment orders. */ export type FulfillmentV2Input = { /** * The fulfillment's tracking information, including a tracking URL, a tracking number, * and the company associated with the fulfillment. */ trackingInfo?: Maybe; /** * Whether the customer is notified. * If set to true, a notification is sent when the fulfillment is created. */ notifyCustomer?: Maybe; /** * Pairs of `fulfillment_order_id` and `fulfillment_order_line_items` that represent the fulfillment * order line items that have to be fulfilled for each fulfillment order. For any given pair, if the * fulfillment order line items are left blank then all the fulfillment order line items of the * associated fulfillment order ID will be fulfilled. */ lineItemsByFulfillmentOrder: Array; }; /** Represents a gift card. */ export type GiftCard = Node & { __typename?: 'GiftCard'; /** The balance of the gift card. */ balance: MoneyV2; /** The date when the gift card was created. */ createdAt: Scalars['DateTime']; /** The customer for whom the gift card was created. */ customer?: Maybe; /** The date when the gift card was disabled. */ disabledAt?: Maybe; /** Indicates if the gift card is enabled. */ enabled: Scalars['Boolean']; /** The date when the gift card will expire. */ expiresOn?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The initial value of the gift card. */ initialValue: MoneyV2; /** The final four characters of the gift card code. */ lastCharacters: Scalars['String']; /** The code of the gift card, with everything except the final four characters masked. */ maskedCode: Scalars['String']; /** A description of the gift card, which is not visible to customers. */ note?: Maybe; /** The order of the gift card. */ order?: Maybe; }; /** An auto-generated type for paginating through multiple GiftCards. */ export type GiftCardConnection = { __typename?: 'GiftCardConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Represents the input for creating a gift card. */ export type GiftCardCreateInput = { /** The initial value of the gift card in the shop's currency. */ initialValue: Scalars['Decimal']; /** * An optional custom code of the gift card. It must be 8-20 characters long and contain * only letters(a-z) and numbers(0-9). A random code will be generated if the code is not provided. */ code?: Maybe; /** The ID of the customer for the gift card. */ customerId?: Maybe; /** The expiry date of the gift card. If unspecified, then the gift card will never expire. */ expiresOn?: Maybe; /** An optional note associated with the gift card. The note isn't visible to customers. */ note?: Maybe; /** * The suffix of the Liquid template that's used to render the gift card online. * For example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`. * When the argument is not supplied, the default `gift_card.liquid` template is used. */ templateSuffix?: Maybe; }; /** Return type for `giftCardCreate` mutation. */ export type GiftCardCreatePayload = { __typename?: 'GiftCardCreatePayload'; /** The gift card that is created. */ giftCard?: Maybe; /** The gift card code which is used to make payments. */ giftCardCode?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `giftCardDisable` mutation. */ export type GiftCardDisablePayload = { __typename?: 'GiftCardDisablePayload'; /** The disabled gift card. */ giftCard?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one GiftCard and a cursor during pagination. */ export type GiftCardEdge = { __typename?: 'GiftCardEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of GiftCardEdge. */ node: GiftCard; }; /** Possible error codes that could be returned by GiftCardUserError. */ export enum GiftCardErrorCode { /** Input value is too long. */ TooLong = 'TOO_LONG', /** Input value is too short. */ TooShort = 'TOO_SHORT', /** Input value is already taken. */ Taken = 'TAKEN', /** Input value is invalid. */ Invalid = 'INVALID', /** Unexpected internal error happened. */ InternalError = 'INTERNAL_ERROR', /** Missing a required argument. */ MissingArgument = 'MISSING_ARGUMENT', /** Input value should be greater than minimum allowed value. */ GreaterThan = 'GREATER_THAN' } /** The set of valid sort keys for the GiftCard query. */ export enum GiftCardSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `customer_name` value. */ CustomerName = 'CUSTOMER_NAME', /** Sort by the `code` value. */ Code = 'CODE', /** Sort by the `balance` value. */ Balance = 'BALANCE', /** Sort by the `amount_spent` value. */ AmountSpent = 'AMOUNT_SPENT', /** Sort by the `initial_value` value. */ InitialValue = 'INITIAL_VALUE', /** Sort by the `disabled_at` value. */ DisabledAt = 'DISABLED_AT', /** Sort by the `expires_on` value. */ ExpiresOn = 'EXPIRES_ON', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Represents a gift card update input. */ export type GiftCardUpdateInput = { /** A description of the gift card, which isn't visible to customers. */ note?: Maybe; /** The date when the gift card will expire. */ expiresOn?: Maybe; /** The customer associated with the gift card. */ customerId?: Maybe; /** * The suffix of the Liquid template that's used to render the gift card online. * For example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`. * When the argument is not supplied, the default `gift_card.liquid` template is used. */ templateSuffix?: Maybe; }; /** Return type for `giftCardUpdate` mutation. */ export type GiftCardUpdatePayload = { __typename?: 'GiftCardUpdatePayload'; /** The updated gift card. */ giftCard?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents an error that happens during the execution of a gift card mutation. */ export type GiftCardUserError = DisplayableError & { __typename?: 'GiftCardUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Connector to event records on a compatible host. */ export type HasEvents = { /** The paginated list of events associated with the host subject. */ events: EventConnection; }; /** Connector to event records on a compatible host. */ export type HasEventsEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Localization extensions associated with the specified resource. For example, the tax id for government invoice. */ export type HasLocalizationExtensions = { /** List of localization extensions for the resource. */ localizationExtensions: LocalizationExtensionConnection; }; /** Localization extensions associated with the specified resource. For example, the tax id for government invoice. */ export type HasLocalizationExtensionsLocalizationExtensionsArgs = { countryCodes?: Maybe>; purposes?: Maybe>; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Localization extensions associated with the specified resource. For example, the tax id for government invoice. */ export type HasLocalizationExtensionsForDraftOrders = { /** List of localization extensions for the resource. */ localizationExtensions: LocalizationExtensionConnection; }; /** Localization extensions associated with the specified resource. For example, the tax id for government invoice. */ export type HasLocalizationExtensionsForDraftOrdersLocalizationExtensionsArgs = { countryCodes?: Maybe>; purposes?: Maybe>; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents information about the metafields associated to the specified resource. */ export type HasMetafields = { /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; }; /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Published translations associated with the resource. */ export type HasPublishedTranslations = { /** The translations associated with the resource. */ translations: Array; }; /** Published translations associated with the resource. */ export type HasPublishedTranslationsTranslationsArgs = { locale: Scalars['String']; }; /** Represents an image resource. */ export type Image = HasMetafields & { __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 identifier for the image. */ id?: Maybe; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** * The location of the original image as a URL. * * If there are any existing transformations in the original source URL, they will remain and not be stripped. */ originalSrc: Scalars['URL']; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** * The location of the image as a URL. * @deprecated Previously an image had a single `src` field. This could either return the original image * location or a URL that contained transformations such as sizing or scale. * * These transformations were specified by arguments on the parent field. * * Now an image has two distinct URL fields: `originalSrc` and `transformedSrc`. * * * `originalSrc` - the original unmodified image URL * * `transformedSrc` - the image URL with the specified transformations included * * To migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`. * * Before: * ```graphql * { * shop { * productImages(maxWidth: 200, scale: 2) { * edges { * node { * src * } * } * } * } * } * ``` * * After: * ```graphql * { * shop { * productImages { * edges { * node { * transformedSrc(maxWidth: 200, scale: 2) * } * } * } * } * } * ``` * */ 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. */ transformedSrc: Scalars['URL']; /** The original width of the image in pixels. Returns `null` if the image is not hosted by Shopify. */ width?: Maybe; }; /** Represents an image resource. */ export type ImageMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents an image resource. */ export type ImageMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents an image resource. */ export type ImagePrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents an image resource. */ export type ImagePrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents an image resource. */ export type ImageTransformedSrcArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; preferredContentType?: Maybe; }; /** An auto-generated type for paginating through multiple Images. */ export type ImageConnection = { __typename?: 'ImageConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** List of supported image content types. */ export enum ImageContentType { /** A PNG image. */ Png = 'PNG', /** A JPG image. */ Jpg = 'JPG', /** A WEBP image. */ Webp = 'WEBP' } /** An auto-generated type which holds one Image and a cursor during pagination. */ export type ImageEdge = { __typename?: 'ImageEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ImageEdge. */ node: Image; }; /** Specifies the input fields for an image. */ export type ImageInput = { /** Globally unique identifier. */ id?: Maybe; /** A word or phrase to share the nature or contents of an image. */ altText?: Maybe; /** The URL of the image. May be a signed upload URL. */ src?: Maybe; }; /** Upload parameter of an image. */ export type ImageUploadParameter = { __typename?: 'ImageUploadParameter'; /** Parameter name. */ name: Scalars['String']; /** Parameter value. */ value: Scalars['String']; }; /** Return type for `inventoryActivate` mutation. */ export type InventoryActivatePayload = { __typename?: 'InventoryActivatePayload'; /** The newly activated inventory level. */ inventoryLevel?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the items and their adjustments. */ export type InventoryAdjustItemInput = { /** ID of the inventory item to adjust. */ inventoryItemId: Scalars['ID']; /** Count by which to adjust the available quantity. */ availableDelta: Scalars['Int']; }; /** Specifies the fields required to adjust the inventory quantity. */ export type InventoryAdjustQuantityInput = { /** ID of the inventory level to adjust. */ inventoryLevelId: Scalars['ID']; /** Count by which to adjust the available quantity. */ availableDelta: Scalars['Int']; }; /** Return type for `inventoryAdjustQuantity` mutation. */ export type InventoryAdjustQuantityPayload = { __typename?: 'InventoryAdjustQuantityPayload'; /** Represents the updated inventory quantity of an inventory item at a specific location. */ inventoryLevel?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `inventoryBulkAdjustQuantityAtLocation` mutation. */ export type InventoryBulkAdjustQuantityAtLocationPayload = { __typename?: 'InventoryBulkAdjustQuantityAtLocationPayload'; /** The updated inventory quantities. */ inventoryLevels?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `inventoryDeactivate` mutation. */ export type InventoryDeactivatePayload = { __typename?: 'InventoryDeactivatePayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Represents the goods available to be shipped to a customer. * It holds essential information about the goods, including SKU and whether it is tracked. */ export type InventoryItem = Node & LegacyInteroperability & { __typename?: 'InventoryItem'; /** The ISO code of the country of origin. */ countryCodeOfOrigin?: Maybe; /** List of country specific harmonized system codes. */ countryHarmonizedSystemCodes: CountryHarmonizedSystemCodeConnection; /** The date and time when the inventory item was created. */ createdAt: Scalars['DateTime']; /** The number of inventory items that share the same SKU with this item. */ duplicateSkuCount: Scalars['Int']; /** The harmonized system code of the item. */ harmonizedSystemCode?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** URL for inventory history web page. */ inventoryHistoryUrl?: Maybe; /** Get the inventory level at a specific location. */ inventoryLevel?: Maybe; /** Paginated list of inventory levels for each location that the inventory item is stocked at. */ inventoryLevels: InventoryLevelConnection; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The number of locations where this inventory item is stocked. */ locationsCount: Scalars['Int']; /** The ISO code of the province of origin. */ provinceCodeOfOrigin?: Maybe; /** Whether the item requires shipping or not. */ requiresShipping: Scalars['Boolean']; /** Inventory item SKU. */ sku?: Maybe; /** Whether the inventory quantities of inventory levels for the item are tracked or not. */ tracked: Scalars['Boolean']; /** Whether changes to the inventory item tracked attribute are allowed. */ trackedEditable: EditableProperty; /** Unit cost associated with the inventory item. */ unitCost?: Maybe; /** The date and time when the inventory item was updated. */ updatedAt: Scalars['DateTime']; /** The variant that owns this inventory item. */ variant: ProductVariant; }; /** * Represents the goods available to be shipped to a customer. * It holds essential information about the goods, including SKU and whether it is tracked. */ export type InventoryItemCountryHarmonizedSystemCodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents the goods available to be shipped to a customer. * It holds essential information about the goods, including SKU and whether it is tracked. */ export type InventoryItemInventoryLevelArgs = { locationId: Scalars['ID']; }; /** * Represents the goods available to be shipped to a customer. * It holds essential information about the goods, including SKU and whether it is tracked. */ export type InventoryItemInventoryLevelsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** An auto-generated type for paginating through multiple InventoryItems. */ export type InventoryItemConnection = { __typename?: 'InventoryItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one InventoryItem and a cursor during pagination. */ export type InventoryItemEdge = { __typename?: 'InventoryItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of InventoryItemEdge. */ node: InventoryItem; }; /** Inventory items. */ export type InventoryItemInput = { /** Unit cost associated with the inventory item, the currency is the shop's default currency. */ cost?: Maybe; /** Whether the inventory item is tracked. */ tracked?: Maybe; }; /** Inventory items. */ export type InventoryItemUpdateInput = { /** Unit cost associated with the inventory item, the currency is the shop's default currency. */ cost?: Maybe; /** Whether the inventory item is tracked. */ tracked?: Maybe; /** The ISO code of the country of origin. */ countryCodeOfOrigin?: Maybe; /** The ISO code of the province of origin. */ provinceCodeOfOrigin?: Maybe; /** The harmonized system code of the inventory item. */ harmonizedSystemCode?: Maybe; /** List of country-specific harmonized system codes. */ countryHarmonizedSystemCodes?: Maybe>; }; /** Return type for `inventoryItemUpdate` mutation. */ export type InventoryItemUpdatePayload = { __typename?: 'InventoryItemUpdatePayload'; /** The updated inventory item. */ inventoryItem?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents the inventory quantity of an inventory item at a specific location. */ export type InventoryLevel = Node & { __typename?: 'InventoryLevel'; /** Quantity of items available at the location. */ available: Scalars['Int']; /** Whether inventoryDeactivate is allowed for this inventory level. */ canDeactivate: Scalars['Boolean']; /** The date and time when the inventory level was created. */ createdAt: Scalars['DateTime']; /** Reason why canDeactivate is false, or impact of deactivating the inventory level. */ deactivationAlert?: Maybe; /** Reason why canDeactivate is false with URLs linked in HTML, or impact of deactivating the inventory level. */ deactivationAlertHtml?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** Quantity of items incoming to the location. */ incoming: Scalars['Int']; /** Inventory item associated with the inventory level. */ item: InventoryItem; /** Location associated with the inventory level. */ location: Location; /** The date and time when the inventory level was updated. */ updatedAt: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple InventoryLevels. */ export type InventoryLevelConnection = { __typename?: 'InventoryLevelConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one InventoryLevel and a cursor during pagination. */ export type InventoryLevelEdge = { __typename?: 'InventoryLevelEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of InventoryLevelEdge. */ node: InventoryLevel; }; /** Inventory quantity at a specific location. */ export type InventoryLevelInput = { /** Sets the quantity available at the location. */ availableQuantity: Scalars['Int']; /** ID of the location. */ locationId: Scalars['ID']; }; /** A job corresponds to some long running task that the client should poll for status. */ export type Job = { __typename?: 'Job'; /** This indicates if the job is still queued or has been run. */ done: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job. */ query?: Maybe; }; /** The locale language allowed for Kit Skill. */ export enum KitSkillLocale { /** English language. */ En = 'EN' } /** Return type for `kitSkillTriggerRequest` mutation. */ export type KitSkillTriggerRequestPayload = { __typename?: 'KitSkillTriggerRequestPayload'; /** Conversation unique identifier sent to Conversation API and returned to app developer. */ conversationUid?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Interoperability metadata for types that directly correspond to a REST Admin API resource. * For example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://help.shopify.com/api/reference/products/product) in the REST Admin API. */ export type LegacyInteroperability = { /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; }; /** * The total number of pending orders on a shop if less then a maximum, or that maximum. * The atMax field indicates when this maximum has been reached. */ export type LimitedPendingOrderCount = { __typename?: 'LimitedPendingOrderCount'; /** This is set when the number of pending orders has reached the maximum. */ atMax: Scalars['Boolean']; /** * The number of pendings orders on the shop. * Limited to a maximum of 10000. */ count: Scalars['Int']; }; /** Represents a single line in a shopping cart. */ export type LineItem = Node & { __typename?: 'LineItem'; /** * Whether the line item's variant has an ID and inventory is managed by Shopify. * @deprecated Use `restockable` instead */ canRestock: Scalars['Boolean']; /** The subscription contract associated with this line item. */ contract?: Maybe; /** The line item's quantity minus the removed quantity. */ currentQuantity: Scalars['Int']; /** List of additional information (metafields) about the line item. */ customAttributes: Array; /** The discounts that have been allocated onto the line item by discount applications. */ discountAllocations: Array; /** * The total line price after discounts are applied. * @deprecated Use `discountedTotalSet` instead */ discountedTotal: Scalars['Money']; /** The total line price after discounts are applied in shop and presentment currencies. */ discountedTotalSet: MoneyBag; /** * The price of a single variant unit after line item discounts are applied. * @deprecated Use `discountedUnitPriceSet` instead */ discountedUnitPrice: Scalars['Money']; /** The price of a single variant unit after line item discounts are applied in shop and presentment currencies. */ discountedUnitPriceSet: MoneyBag; /** The duties associated with the line item. */ duties: Array; /** The total number of units to fulfill. */ fulfillableQuantity: Scalars['Int']; /** * Name of the service provider who fulfilled the order. * * Valid values are either **manual** or the name of the provider. * For example, **amazon**, **shipwire**. */ fulfillmentService: FulfillmentService; /** * The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, * 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. */ fulfillmentStatus: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The Image object associated to the line item's variant. */ image?: Maybe; /** Whether the line item can be edited or not. */ merchantEditable: Scalars['Boolean']; /** Name of the product. */ name: Scalars['String']; /** A count of the number of line items that cannot be fulfilled. */ nonFulfillableQuantity: Scalars['Int']; /** * Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. * @deprecated Use `originalTotalSet` instead */ originalTotal: Scalars['Money']; /** Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies. */ originalTotalSet: MoneyBag; /** * Variant price without any discounts applied. * @deprecated Use `originalUnitPriceSet` instead */ originalUnitPrice: Scalars['Money']; /** Variant price without any discounts applied in shop and presentment currencies. */ originalUnitPriceSet: MoneyBag; /** The Product object associated with this line item's variant. */ product?: Maybe; /** The number of variant items ordered. */ quantity: Scalars['Int']; /** The line item's quantity minus its refundedQuantity. */ refundableQuantity: Scalars['Int']; /** Whether physical shipping is required for the variant. */ requiresShipping: Scalars['Boolean']; /** Whether the line item's variant has an ID and inventory is managed by Shopify. */ restockable: Scalars['Boolean']; /** The selling plan details associated with the line item. */ sellingPlan?: Maybe; /** Variant SKU number. */ sku?: Maybe; /** The TaxLine object connected to this line item. */ taxLines: Array; /** Whether the variant is taxable. */ taxable: Scalars['Boolean']; /** Title of the product or variant (this field only applies to custom line items). */ title: Scalars['String']; /** * The sum of all AppliedDiscounts on this line item. * @deprecated Use `totalDiscountSet` instead */ totalDiscount: Scalars['Money']; /** The sum of all AppliedDiscounts on this line item in shop and presentment currencies. */ totalDiscountSet: MoneyBag; /** * The total discounted value of unfulfilled units. * @deprecated Use `unfulfilledDiscountedTotalSet` instead */ unfulfilledDiscountedTotal: Scalars['Money']; /** The total discounted value of unfulfilled units in shop and presentment currencies. */ unfulfilledDiscountedTotalSet: MoneyBag; /** * The total value before discount of all unfulfilled units. * @deprecated Use `unfulfilledOriginalTotalSet` instead */ unfulfilledOriginalTotal: Scalars['Money']; /** The total value before discount of all unfulfilled units in shop and presentment currencies. */ unfulfilledOriginalTotalSet: MoneyBag; /** The number of units not yet fulfilled. */ unfulfilledQuantity: Scalars['Int']; /** The Variant object associated with this line item. */ variant?: Maybe; /** Name of the variant. */ variantTitle?: Maybe; /** Name of the vendor who made the variant. */ vendor?: Maybe; }; /** Represents a single line in a shopping cart. */ export type LineItemImageArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Represents a single line in a shopping cart. */ export type LineItemTaxLinesArgs = { first?: Maybe; }; /** An auto-generated type for paginating through multiple LineItems. */ export type LineItemConnection = { __typename?: 'LineItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one LineItem and a cursor during pagination. */ export type LineItemEdge = { __typename?: 'LineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of LineItemEdge. */ node: LineItem; }; /** Represents a single line in a shopping cart. */ export type LineItemMutable = Node & { __typename?: 'LineItemMutable'; /** * Whether the line item's variant has an ID and inventory is managed by Shopify. * @deprecated Use `restockable` instead */ canRestock: Scalars['Boolean']; /** List of additional information (metafields) about the line item. */ customAttributes: Array; /** The discounts that have been allocated onto the line item by discount applications. */ discountAllocations: Array; /** * The total line price after discounts are applied. * @deprecated Use `discountedTotalSet` instead */ discountedTotal: Scalars['Money']; /** The total line price after discounts are applied in shop and presentment currencies. */ discountedTotalSet: MoneyBag; /** * The price of a single variant unit after line item discounts are applied. * @deprecated Use `discountedUnitPriceSet` instead */ discountedUnitPrice: Scalars['Money']; /** The price of a single variant unit after line item discounts are applied in shop and presentment currencies. */ discountedUnitPriceSet: MoneyBag; /** The total number of units to fulfill. */ fulfillableQuantity: Scalars['Int']; /** * Name of the service provider who fulfilled the order. * * Valid values are either **manual** or the name of the provider. * For example, **amazon**, **shipwire**. */ fulfillmentService: FulfillmentService; /** * The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, * 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. */ fulfillmentStatus: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The Image object associated to the line item's variant. */ image?: Maybe; /** Whether the line item can be edited or not. */ merchantEditable: Scalars['Boolean']; /** Name of the product. */ name: Scalars['String']; /** A count of the number of line items that cannot be fulfilled. */ nonFulfillableQuantity: Scalars['Int']; /** * Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. * @deprecated Use `originalTotalSet` instead */ originalTotal: Scalars['Money']; /** Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies. */ originalTotalSet: MoneyBag; /** * Variant price without any discounts applied. * @deprecated Use `originalUnitPriceSet` instead */ originalUnitPrice: Scalars['Money']; /** Variant price without any discounts applied in shop and presentment currencies. */ originalUnitPriceSet: MoneyBag; /** The Product object associated with this line item's variant. */ product?: Maybe; /** Number of variant items ordered. */ quantity: Scalars['Int']; /** The line item's quantity minus its refundedQuantity. */ refundableQuantity: Scalars['Int']; /** Whether physical shipping is required for the variant. */ requiresShipping: Scalars['Boolean']; /** Whether the line item's variant has an ID and inventory is managed by Shopify. */ restockable: Scalars['Boolean']; /** Variant SKU number. */ sku?: Maybe; /** The TaxLine object connected to this line item. */ taxLines: Array; /** Whether the variant is taxable. */ taxable: Scalars['Boolean']; /** Title of the product or variant (this field only applies to custom line items). */ title: Scalars['String']; /** * The sum of all AppliedDiscounts on this line item. * @deprecated Use `totalDiscountSet` instead */ totalDiscount: Scalars['Money']; /** The sum of all AppliedDiscounts on this line item in shop and presentment currencies. */ totalDiscountSet: MoneyBag; /** * The total discounted value of unfulfilled units. * @deprecated Use `unfulfilledDiscountedTotalSet` instead */ unfulfilledDiscountedTotal: Scalars['Money']; /** The total discounted value of unfulfilled units in shop and presentment currencies. */ unfulfilledDiscountedTotalSet: MoneyBag; /** * The total value before discount of all unfulfilled units. * @deprecated Use `unfulfilledOriginalTotalSet` instead */ unfulfilledOriginalTotal: Scalars['Money']; /** The total value before discount of all unfulfilled units in shop and presentment currencies. */ unfulfilledOriginalTotalSet: MoneyBag; /** The number of units not yet fulfilled. */ unfulfilledQuantity: Scalars['Int']; /** The Variant object associated with this line item. */ variant?: Maybe; /** Name of the variant. */ variantTitle?: Maybe; /** Name of the vendor who made the variant. */ vendor?: Maybe; }; /** Represents a single line in a shopping cart. */ export type LineItemMutableImageArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Represents a single line in a shopping cart. */ export type LineItemMutableTaxLinesArgs = { first?: Maybe; }; /** An auto-generated type for paginating through multiple LineItemMutables. */ export type LineItemMutableConnection = { __typename?: 'LineItemMutableConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one LineItemMutable and a cursor during pagination. */ export type LineItemMutableEdge = { __typename?: 'LineItemMutableEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of LineItemMutableEdge. */ node: LineItemMutable; }; /** Represents the selling plan for a line item. */ export type LineItemSellingPlan = { __typename?: 'LineItemSellingPlan'; /** The name of the selling plan for display purposes. */ name: Scalars['String']; }; /** A link to direct users to. */ export type Link = HasPublishedTranslations & { __typename?: 'Link'; /** A context-sensitive label for the link. */ label: Scalars['String']; /** The translations associated with the resource. */ translations: Array; /** The URL that the link visits. */ url: Scalars['URL']; }; /** A link to direct users to. */ export type LinkTranslationsArgs = { locale: Scalars['String']; }; /** A locale. */ export type Locale = { __typename?: 'Locale'; /** Locale ISO code. */ isoCode: Scalars['String']; /** Locale name. */ name: Scalars['String']; }; /** Represents the value captured by a localization extension, like a tax id. */ export type LocalizationExtension = { __typename?: 'LocalizationExtension'; /** Country ISO 3166-1 alpha-2 code. */ countryCode: CountryCode; /** The localized extension keys that are allowed. */ key: LocalizationExtensionKey; /** The purpose of this localization extension. */ purpose: LocalizationExtensionPurpose; /** The localized extension title. */ title: Scalars['String']; /** The value of the field. */ value: Scalars['String']; }; /** An auto-generated type for paginating through multiple LocalizationExtensions. */ export type LocalizationExtensionConnection = { __typename?: 'LocalizationExtensionConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one LocalizationExtension and a cursor during pagination. */ export type LocalizationExtensionEdge = { __typename?: 'LocalizationExtensionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of LocalizationExtensionEdge. */ node: LocalizationExtension; }; /** Specifies the input fields for a LocalizationExtensionInput. */ export type LocalizationExtensionInput = { /** The key for the localization extension. */ key: LocalizationExtensionKey; /** The localization extension value. */ value: Scalars['String']; }; /** The key of a localization extension. */ export enum LocalizationExtensionKey { /** Extension key 'tax_credential_br' for country BR. */ TaxCredentialBr = 'TAX_CREDENTIAL_BR', /** Extension key 'shipping_credential_br' for country BR. */ ShippingCredentialBr = 'SHIPPING_CREDENTIAL_BR', /** Extension key 'shipping_credential_cn' for country CN. */ ShippingCredentialCn = 'SHIPPING_CREDENTIAL_CN', /** Extension key 'tax_credential_it' for country IT. */ TaxCredentialIt = 'TAX_CREDENTIAL_IT', /** Extension key 'tax_email_it' for country IT. */ TaxEmailIt = 'TAX_EMAIL_IT', /** Extension key 'shipping_credential_kr' for country KR. */ ShippingCredentialKr = 'SHIPPING_CREDENTIAL_KR' } /** The purpose of a localization extension. */ export enum LocalizationExtensionPurpose { /** Extensions that are used for shipping purposes, for example, customs clearance. */ Shipping = 'SHIPPING', /** Extensions that are used for taxes purposes, for example, invoicing. */ Tax = 'TAX' } /** Represents the location where the physical good resides. */ export type Location = Node & LegacyInteroperability & { __typename?: 'Location'; /** Whether this location can be reactivated. */ activatable: Scalars['Boolean']; /** The LocationAddress object for location. */ address: LocationAddress; /** Whether the location address has been verified. */ addressVerified: Scalars['Boolean']; /** Whether this location can be deactivated. */ deactivatable: Scalars['Boolean']; /** Date and time the location was deactivated (null if location is still active). Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z". */ deactivatedAt?: Maybe; /** Whether this location can be deleted. */ deletable: Scalars['Boolean']; /** Name of the service provider that fulfills from this location. */ fulfillmentService?: Maybe; /** Indicates whether this location can fulfill online orders. */ fulfillsOnlineOrders: Scalars['Boolean']; /** Indicates whether or not this location has active inventory. */ hasActiveInventory: Scalars['Boolean']; /** Indicates whether or not this location has unfulfilled orders. */ hasUnfulfilledOrders: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** A single inventory level for the given inventory item. */ inventoryLevel?: Maybe; /** Paginated list of inventory levels for inventory items stocked at the location. */ inventoryLevels: InventoryLevelConnection; /** Whether the location is active. */ isActive: Scalars['Boolean']; /** * Whether the location is your primary location for shipping inventory. * @deprecated The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location */ isPrimary: Scalars['Boolean']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The name of the location. */ name: Scalars['String']; /** Indicates whether or not this location is used for calculating shipping rates. */ shipsInventory: Scalars['Boolean']; /** List of suggested addresses for this location (empty if none). */ suggestedAddresses: Array; }; /** Represents the location where the physical good resides. */ export type LocationInventoryLevelArgs = { inventoryItemId: Scalars['ID']; }; /** Represents the location where the physical good resides. */ export type LocationInventoryLevelsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** Represents the address of the location. */ export type LocationAddress = { __typename?: 'LocationAddress'; /** The first line of the address for the location. */ address1?: Maybe; /** The second line of the address for the location. */ address2?: Maybe; /** The city of the location. */ city?: Maybe; /** The country of the location. */ country?: Maybe; /** The two-letter country code of the location. */ countryCode?: Maybe; /** A formatted version of the location address. */ formatted: Array; /** The latitude coordinates of the location. */ latitude?: Maybe; /** The longitude coordinates of the location. */ longitude?: Maybe; /** The phone number of the location. */ phone?: Maybe; /** The province of the location. */ province?: Maybe; /** * The code for the region of the address, such as the province, state, or district. * For example QC for Quebec, Canada. */ provinceCode?: Maybe; /** The ZIP code of the location. */ zip?: Maybe; }; /** An auto-generated type for paginating through multiple Locations. */ export type LocationConnection = { __typename?: 'LocationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one Location and a cursor during pagination. */ export type LocationEdge = { __typename?: 'LocationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of LocationEdge. */ node: Location; }; /** The set of valid sort keys for the Location query. */ export enum LocationSortKeys { /** Sort by the `name` value. */ Name = 'NAME', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Represents a suggested address for a location. */ export type LocationSuggestedAddress = { __typename?: 'LocationSuggestedAddress'; /** The first line of the suggested address. */ address1?: Maybe; /** The second line of the suggested address. */ address2?: Maybe; /** The city of the suggested address. */ city?: Maybe; /** The country of the suggested address. */ country?: Maybe; /** The country code of the suggested address. */ countryCode?: Maybe; /** A formatted version of the suggested address. */ formatted: Array; /** The province of the suggested address. */ province?: Maybe; /** The province code of the suggested address. */ provinceCode?: Maybe; /** The ZIP code of the suggested address. */ zip?: Maybe; }; /** * Represents a customer mailing address. * * For example, a customer's default address and an order's billing address are both mailling addresses. */ export type MailingAddress = Node & { __typename?: 'MailingAddress'; /** The first line of the address. Typically the street address or PO Box number. */ address1?: Maybe; /** The second line of the address. Typically the number of the apartment, suite, or unit. */ address2?: Maybe; /** The name of the city, district, village, or town. */ city?: Maybe; /** The name of the customer's company or organization. */ company?: Maybe; /** The name of the country. */ country?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. * @deprecated Use `countryCodeV2` instead */ countryCode?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. */ countryCodeV2?: Maybe; /** The first name of the customer. */ firstName?: Maybe; /** A formatted version of the address, customized by the provided arguments. */ formatted: Array; /** A comma-separated list of the values for city, province, and country. */ formattedArea?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The last name of the customer. */ lastName?: Maybe; /** The latitude coordinate of the customer address. */ latitude?: Maybe; /** The longitude coordinate of the customer address. */ longitude?: Maybe; /** The full name of the customer, based on firstName and lastName. */ name?: Maybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. */ phone?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** * The two-letter code for the region. * * For example, ON. */ provinceCode?: Maybe; /** The zip or postal code of the address. */ zip?: Maybe; }; /** * Represents a customer mailing address. * * For example, a customer's default address and an order's billing address are both mailling addresses. */ export type MailingAddressFormattedArgs = { withName?: Maybe; withCompany?: Maybe; }; /** The fields used to create or update a mailing address. */ export type MailingAddressInput = { /** The first line of the address. Typically the street address or PO Box number. */ address1?: Maybe; /** The second line of the address. Typically the number of the apartment, suite, or unit. */ address2?: Maybe; /** The name of the city, district, village, or town. */ city?: Maybe; /** The name of the customer's company or organization. */ company?: Maybe; /** The name of the country. This argument is deprecated: Use `countryCode` instead. */ country?: Maybe; /** The two-letter code for the country of the address. */ countryCode?: Maybe; /** The first name of the customer. */ firstName?: Maybe; /** This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed. */ id?: Maybe; /** The last name of the customer. */ lastName?: Maybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. */ phone?: Maybe; /** The region of the address, such as the province, state, or district. This argument is deprecated: Use `provinceCode` instead. */ province?: Maybe; /** * The code for the region of the address, such as the province, state, or district. * For example QC for Quebec, Canada. */ provinceCode?: Maybe; /** The zip or postal code of the address. */ zip?: Maybe; }; /** Manual discount applications capture the intentions of a discount that was manually created for an order. */ export type ManualDiscountApplication = DiscountApplication & { __typename?: 'ManualDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The description of the discount application. */ description?: Maybe; /** * An ordered index that can be used to identify the discount application and indicate the precedence * of the discount application for calculations. */ index: Scalars['Int']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The title of the discount application. */ title: Scalars['String']; /** The value of the discount application. */ value: PricingValue; }; /** A marketing activity represents marketing created by an app on behalf of the merchant. */ export type MarketingActivity = Node & { __typename?: 'MarketingActivity'; /** The url of the activity listing page of this marketing activity in the marketing section. */ activityListUrl?: Maybe; /** Amount spent on this marketing activity. */ adSpend?: Maybe; /** The app which created this marketing activity. */ app: App; /** Errors generated when app was trying to complete this activity. */ appErrors?: Maybe; /** The budget for this marketing activity. */ budget?: Maybe; /** The date and time when the marketing activity was created. */ createdAt: Scalars['DateTime']; /** The form data of the marketing activity. */ formData?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The broad category of marketing, used for reporting aggregation. */ marketingChannel: MarketingChannel; /** Associated marketing event of this marketing activity. */ marketingEvent?: Maybe; /** A contextual description of the marketing activity based on the platform and tactic used. */ sourceAndMedium: Scalars['String']; /** Status helps to identify if this marketing activity has been completed, queued, failed etc. */ status: MarketingActivityStatus; /** StatusBadgeType helps to identify the color of the status badge. */ statusBadgeType?: Maybe; /** Status label to describe the status of the marketing activity. */ statusLabel: Scalars['String']; /** * The [date and time]( * https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601 * ) when the activity's status last changed. */ statusTransitionedAt?: Maybe; /** The method of marketing used for this marketing activity. */ tactic: MarketingTactic; /** Expected status set by app in prior to an asynchronous operation. */ targetStatus?: Maybe; /** Title of this marketing activity. */ title: Scalars['String']; /** The date and time when the marketing activity was updated. */ updatedAt: Scalars['DateTime']; /** The set of UTM parameters being tracked for this marketing activity. */ utmParameters?: Maybe; }; /** This type combines budget amount and its marketing budget type. */ export type MarketingActivityBudgetInput = { /** Budget type for marketing activity. */ budgetType?: Maybe; /** Amount of budget for the marketing activity. */ total?: Maybe; }; /** An auto-generated type for paginating through multiple MarketingActivities. */ export type MarketingActivityConnection = { __typename?: 'MarketingActivityConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Specifies the input fields required to create a marketing activity. */ export type MarketingActivityCreateInput = { /** The title of the marketing activity. */ marketingActivityTitle?: Maybe; /** The form data in JSON serialized as a string. */ formData?: Maybe; /** The ID of the marketing activity extension. */ marketingActivityExtensionId: Scalars['ID']; /** Encoded context containing marketing campaign id. */ context?: Maybe; /** * Specifies the * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) * that are associated with a related marketing campaign. UTMInput is required for all Marketing * tactics except Storefront App. */ utm?: Maybe; /** The current state of the marketing activity. */ status: MarketingActivityStatus; /** The budget for this marketing activity. */ budget?: Maybe; }; /** Return type for `marketingActivityCreate` mutation. */ export type MarketingActivityCreatePayload = { __typename?: 'MarketingActivityCreatePayload'; /** The created marketing activity. */ marketingActivity?: Maybe; /** The path to return back to shopify admin from embedded editor. */ redirectPath?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one MarketingActivity and a cursor during pagination. */ export type MarketingActivityEdge = { __typename?: 'MarketingActivityEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of MarketingActivityEdge. */ node: MarketingActivity; }; /** The error code resulted from the marketing activity extension integration. */ export enum MarketingActivityExtensionAppErrorCode { /** The shop/user must be onboarded to use the app. */ NotOnboardedError = 'NOT_ONBOARDED_ERROR', /** The app has returned validation errors. */ ValidationError = 'VALIDATION_ERROR', /** The app is not responding or returning unexpected data. */ ApiError = 'API_ERROR', /** The app has returned an error when invoking the platform. */ PlatformError = 'PLATFORM_ERROR', /** The app needs to be installed. */ InstallRequiredError = 'INSTALL_REQUIRED_ERROR' } /** Represents errors returned from apps when using the marketing activity extension. */ export type MarketingActivityExtensionAppErrors = { __typename?: 'MarketingActivityExtensionAppErrors'; /** The app error type. */ code: MarketingActivityExtensionAppErrorCode; /** The list of errors returned by the app. */ userErrors: Array; }; /** The set of valid sort keys for the MarketingActivity query. */ export enum MarketingActivitySortKeys { /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Status helps to identify if this marketing activity has been completed, queued, failed etc. */ export enum MarketingActivityStatus { /** This marketing activity is currently running. */ Active = 'ACTIVE', /** This marketing activity is permanently unavailable. */ Deleted = 'DELETED', /** This marketing activity was deleted and it was triggered from outside of Shopify. */ DeletedExternally = 'DELETED_EXTERNALLY', /** This marketing activity is disconnected and no longer editable. */ Disconnected = 'DISCONNECTED', /** This marketing activity is started but not yet created. */ Draft = 'DRAFT', /** This marketing activity is unable to run. */ Failed = 'FAILED', /** This marketing activity has completed running. */ Inactive = 'INACTIVE', /** This marketing activity is currently not running. */ Paused = 'PAUSED', /** This marketing activity is pending creation on the app's platform. */ Pending = 'PENDING', /** This marketing activity is scheduled to run. */ Scheduled = 'SCHEDULED', /** There is no defined status for external marketing activities. */ Undefined = 'UNDEFINED' } /** StatusBadgeType helps to identify the color of the status badge. */ export enum MarketingActivityStatusBadgeType { /** This status badge has type default. */ Default = 'DEFAULT', /** This status badge has type success. */ Success = 'SUCCESS', /** This status badge has type attention. */ Attention = 'ATTENTION', /** This status badge has type warning. */ Warning = 'WARNING', /** This status badge has type info. */ Info = 'INFO' } /** Specifies the input fields required to update a marketing activity. */ export type MarketingActivityUpdateInput = { /** The id for this marketing activity. */ id: Scalars['ID']; /** The ID of the recommendation this marketing activity was created from, if one exists. */ marketingRecommendationId?: Maybe; /** The title of this marketing activity. */ title?: Maybe; /** The budget for this marketing activity. */ budget?: Maybe; /** The cumulative amount spent on this marketing activity. This argument is deprecated: Use `MarketingEngagementCreate.MarketingEngagementInput.adSpend` GraphQL to send the ad spend. */ adSpend?: Maybe; /** The current state of the marketing activity. */ status?: Maybe; /** The target state of the marketing activity. */ targetStatus?: Maybe; /** The form data of the marketing activity. */ formData?: Maybe; /** * Specifies the * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) * that are associated with a related marketing campaign. UTMInput is required for all Marketing * tactics except Storefront App. This utm param can be only set once and never modified. */ utm?: Maybe; /** * A list of the items that were marketed in this marketing activity. Valid types for these items are: * * `Product` * * `Shop` (Must be your current shop). */ marketedResources?: Maybe>; /** Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback. */ context?: Maybe; /** Error messages generated when app was trying to complete this activity. */ errors?: Maybe; }; /** Return type for `marketingActivityUpdate` mutation. */ export type MarketingActivityUpdatePayload = { __typename?: 'MarketingActivityUpdatePayload'; /** The updated marketing activity. */ marketingActivity?: Maybe; /** The path to return back to shopify admin from embedded editor. */ redirectPath?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** This type combines budget amount and its marketing budget type. */ export type MarketingBudget = { __typename?: 'MarketingBudget'; /** The budget type for a marketing activity. */ budgetType: MarketingBudgetBudgetType; /** The amount of budget for marketing activity. */ total: MoneyV2; }; /** The budget type for a marketing activity. */ export enum MarketingBudgetBudgetType { /** A daily budget. */ Daily = 'DAILY', /** A budget for the lifetime of a marketing activity. */ Lifetime = 'LIFETIME' } /** The available marketing channels for a marketing activity or event. A marketing channel is broad category of marketing, used for reporting aggregation. */ export enum MarketingChannel { /** Paid search. */ Search = 'SEARCH', /** Displayed ads. */ Display = 'DISPLAY', /** Social media. */ Social = 'SOCIAL', /** Email. */ Email = 'EMAIL', /** Referral links. */ Referral = 'REFERRAL' } /** Marketing engagement represents customer activity taken on a marketing event. */ export type MarketingEngagement = { __typename?: 'MarketingEngagement'; /** The total ad spend for the day, if the marketing event is a paid ad with a daily spend. */ adSpend?: Maybe; /** The total number of clicks on the marketing event for the day. */ clicksCount?: Maybe; /** The total number of comments for the day. */ commentsCount?: Maybe; /** The total number of complaints for the day. */ complaintsCount?: Maybe; /** The total number of fails for the day. */ failsCount?: Maybe; /** The total number of favorites for the day. */ favoritesCount?: Maybe; /** The date time at which the data was fetched. */ fetchedAt?: Maybe; /** The total number of impressions for the day. */ impressionsCount?: Maybe; /** Whether the engagements are reported as lifetime values rather than daily totals. */ isCumulative?: Maybe; /** The marketing activity related to this engagement. */ marketingActivity: MarketingActivity; /** The date that these engagements occurred on. */ occurredOn: Scalars['Date']; /** The total number of sends for the day. */ sendsCount?: Maybe; /** The total number of shares for the day. */ sharesCount?: Maybe; /** The total number of unique clicks for the day. */ uniqueClicksCount?: Maybe; /** The total number of unique views for the day. */ uniqueViewsCount?: Maybe; /** The total number of unsubscribes for the day. */ unsubscribesCount?: Maybe; /** The UTC Offset that the app is using to determine which date to allocate spend to. */ utcOffset?: Maybe; /** The total number of views for the day. */ viewsCount?: Maybe; }; /** Return type for `marketingEngagementCreate` mutation. */ export type MarketingEngagementCreatePayload = { __typename?: 'MarketingEngagementCreatePayload'; /** The marketing engagement that was created. */ marketingEngagement?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** This object represents marketing engagement input fields for a marketing engagement. */ export type MarketingEngagementInput = { /** The date that these engagements occurred on. */ occurredOn: Scalars['Date']; /** The total number of impressions for the day. */ impressionsCount?: Maybe; /** The total number of views for the day. */ viewsCount?: Maybe; /** The total number of clicks on the marketing event for the day. */ clicksCount?: Maybe; /** The total number of shares for the day. */ sharesCount?: Maybe; /** The total number of favorites for the day. */ favoritesCount?: Maybe; /** The total number of comments for the day. */ commentsCount?: Maybe; /** The total number of unsubscribes for the day. */ unsubscribesCount?: Maybe; /** The total number of complaints for the day. */ complaintsCount?: Maybe; /** The total number of fails for the day. */ failsCount?: Maybe; /** The total number of sends for the day. */ sendsCount?: Maybe; /** The total number of unique views for the day. */ uniqueViewsCount?: Maybe; /** The total number of unique clicks for the day. */ uniqueClicksCount?: Maybe; /** The total ad spend for the day, if the marketing event is a paid ad with a daily spend. */ adSpend?: Maybe; /** Whether the engagements are reported as lifetime values rather than daily totals. */ isCumulative?: Maybe; /** The UTC Offset that the app is using to determine which date to allocate spend to. */ utcOffset?: Maybe; /** The date time at which the data was fetched. */ fetchedAt?: Maybe; }; /** Represents actions that market a merchant's store or products. */ export type MarketingEvent = Node & LegacyInteroperability & { __typename?: 'MarketingEvent'; /** The app that the marketing event is attributed to. */ app: App; /** The marketing channel used by the marketing event. */ channel?: Maybe; /** A human-readable description of the marketing event. */ description?: Maybe; /** The date and time when the marketing event ended. */ endedAt?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The URL where the marketing event can be managed. */ manageUrl?: Maybe; /** The URL where the marketing event can be previewed. */ previewUrl?: Maybe; /** An optional ID that helps Shopify validate engagement data. */ remoteId?: Maybe; /** The date and time when the marketing event is scheduled to end. */ scheduledToEndAt?: Maybe; /** * Where the `MarketingEvent` occurred and what kind of content was used. * Because `utmSource` and `utmMedium` are often used interchangeably, this is * based on a combination of `marketingChannel`, `referringDomain`, and `type` to * provide a consistent representation for any given piece of marketing * regardless of the app that created it. */ sourceAndMedium: Scalars['String']; /** The date and time when the marketing event started. */ startedAt: Scalars['DateTime']; /** * The display text for the marketing event type. * @deprecated Use `sourceAndMedium` instead */ targetTypeDisplayText: Scalars['String']; /** The marketing event type. */ type: MarketingTactic; /** The name of the marketing campaign. */ utmCampaign?: Maybe; /** The medium that the marketing campaign is using. Example values: `cpc`, `banner`. */ utmMedium?: Maybe; /** The referrer of the marketing event. Example values: `google`, `newsletter`. */ utmSource?: Maybe; }; /** An auto-generated type for paginating through multiple MarketingEvents. */ export type MarketingEventConnection = { __typename?: 'MarketingEventConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one MarketingEvent and a cursor during pagination. */ export type MarketingEventEdge = { __typename?: 'MarketingEventEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of MarketingEventEdge. */ node: MarketingEvent; }; /** The set of valid sort keys for the MarketingEvent query. */ export enum MarketingEventSortKeys { /** Sort by the `started_at` value. */ StartedAt = 'STARTED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The available types of marketing event. */ export enum MarketingTactic { /** An abandoned cart recovery email. */ AbandonedCart = 'ABANDONED_CART', /** An ad, such as a Facebook ad. */ Ad = 'AD', /** An affiliate link. */ Affiliate = 'AFFILIATE', /** A link. */ Link = 'LINK', /** A loyalty program. */ Loyalty = 'LOYALTY', /** A messaging app, such as Facebook Messenger. */ Message = 'MESSAGE', /** A newsletter. */ Newsletter = 'NEWSLETTER', /** A notification in the Shopify admin. */ Notification = 'NOTIFICATION', /** A blog post. */ Post = 'POST', /** A retargeting ad. */ Retargeting = 'RETARGETING', /** A transactional email. */ Transactional = 'TRANSACTIONAL', /** Search engine optimization. */ Seo = 'SEO', /** A direct visit to the online store. */ Direct = 'DIRECT', /** Popup on merchant's store. */ StorefrontApp = 'STOREFRONT_APP', /** A display ad. */ Display = 'DISPLAY', /** Paid search. */ Search = 'SEARCH', /** A follow-up email. */ FollowUp = 'FOLLOW_UP', /** A promotional receipt. */ Receipt = 'RECEIPT' } /** Represents a media interface. */ export type Media = { /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** The media content type. */ mediaContentType: MediaContentType; /** Any errors which have occurred on the media. */ mediaErrors: Array; /** The preview image for the media. */ preview?: Maybe; /** Current status of the media. */ status: MediaStatus; }; /** An auto-generated type for paginating through multiple Media. */ export type MediaConnection = { __typename?: 'MediaConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** The possible content types for a media object. */ export enum MediaContentType { /** A Shopify hosted video. */ Video = 'VIDEO', /** An externally hosted video. */ ExternalVideo = 'EXTERNAL_VIDEO', /** A 3d model. */ Model_3D = 'MODEL_3D', /** A Shopify hosted image. */ Image = 'IMAGE' } /** An auto-generated type which holds one Media and a cursor during pagination. */ export type MediaEdge = { __typename?: 'MediaEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of MediaEdge. */ node: Media; }; /** Represents a media error. */ export type MediaError = { __typename?: 'MediaError'; /** Code representing the type of error. */ code: MediaErrorCode; /** Additional details regarding the error. */ details?: Maybe; /** Translated error message. */ message: Scalars['String']; }; /** Error types for media. */ export enum MediaErrorCode { /** Media error has occured for unknown reason. */ Unknown = 'UNKNOWN', /** Media could not be processed because the signed url was invalid. */ InvalidSignedUrl = 'INVALID_SIGNED_URL', /** Media could not be processed because the image could not be downloaded. */ ImageDownloadFailure = 'IMAGE_DOWNLOAD_FAILURE', /** Media could not be processed because the image could not be processed. */ ImageProcessingFailure = 'IMAGE_PROCESSING_FAILURE', /** Media timed out because it is currently being modified by another operation. */ MediaTimeoutError = 'MEDIA_TIMEOUT_ERROR', /** Media could not be created because the external video could not be found. */ ExternalVideoNotFound = 'EXTERNAL_VIDEO_NOT_FOUND', /** Media could not be created because the external video is not listed or is private. */ ExternalVideoUnlisted = 'EXTERNAL_VIDEO_UNLISTED', /** Media could not be created because the external video has an invalid aspect ratio. */ ExternalVideoInvalidAspectRatio = 'EXTERNAL_VIDEO_INVALID_ASPECT_RATIO', /** Media could not be created because embed permissions are disabled for this video. */ ExternalVideoEmbedDisabled = 'EXTERNAL_VIDEO_EMBED_DISABLED', /** Media could not be created because video is either not found or still transcoding. */ ExternalVideoEmbedNotFoundOrTranscoding = 'EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING', /** Media could not be created because the metadata could not be read. */ VideoMetadataReadError = 'VIDEO_METADATA_READ_ERROR', /** Media could not be created because it has an invalid file type. */ VideoInvalidFiletypeError = 'VIDEO_INVALID_FILETYPE_ERROR', /** Media could not be created because it does not meet the minimum width requirement. */ VideoMinWidthError = 'VIDEO_MIN_WIDTH_ERROR', /** Media could not be created because it does not meet the maximum width requirement. */ VideoMaxWidthError = 'VIDEO_MAX_WIDTH_ERROR', /** Media could not be created because it does not meet the minimum height requirement. */ VideoMinHeightError = 'VIDEO_MIN_HEIGHT_ERROR', /** Media could not be created because it does not meet the maximum height requirement. */ VideoMaxHeightError = 'VIDEO_MAX_HEIGHT_ERROR', /** Media could not be created because it does not meet the minimum duration requirement. */ VideoMinDurationError = 'VIDEO_MIN_DURATION_ERROR', /** Media could not be created because it does not meet the maximum duration requirement. */ VideoMaxDurationError = 'VIDEO_MAX_DURATION_ERROR', /** Video failed validation. */ VideoValidationError = 'VIDEO_VALIDATION_ERROR', /** Model failed validation. */ Model3DValidationError = 'MODEL3D_VALIDATION_ERROR', /** Media could not be created because the model's thumbnail generation failed. */ Model3DThumbnailGenerationError = 'MODEL3D_THUMBNAIL_GENERATION_ERROR', /** Media could not be created because the model can't be converted to USDZ format. */ Model3DGlbToUsdzConversionError = 'MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR', /** Media could not be created because the model file failed processing. */ Model3DGlbOutputCreationError = 'MODEL3D_GLB_OUTPUT_CREATION_ERROR', /** Media could not be created because the image is an unsupported file type. */ UnsupportedImageFileType = 'UNSUPPORTED_IMAGE_FILE_TYPE', /** Media could not be created because the image size is too large. */ InvalidImageFileSize = 'INVALID_IMAGE_FILE_SIZE' } /** Host for a Media Resource. */ export enum MediaHost { /** Host for YouTube embedded videos. */ Youtube = 'YOUTUBE', /** Host for Vimeo embedded videos. */ Vimeo = 'VIMEO' } /** Represents a Shopify hosted image. */ export type MediaImage = Node & Media & { __typename?: 'MediaImage'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The image for the media. */ image?: Maybe; /** The media content type. */ mediaContentType: MediaContentType; /** Any errors which have occurred on the media. */ mediaErrors: Array; /** The MIME type of the image. */ mimeType?: Maybe; /** The preview image for the media. */ preview?: Maybe; /** Current status of the media. */ status: MediaStatus; }; /** Represents the preview image for a media. */ export type MediaPreviewImage = { __typename?: 'MediaPreviewImage'; /** The preview image for the media. */ image?: Maybe; /** Current status of the preview image. */ status: MediaPreviewImageStatus; }; /** The possible statuses for a media preview image. */ export enum MediaPreviewImageStatus { /** Preview image is uploaded but not yet processed. */ Uploaded = 'UPLOADED', /** Preview image is being processed. */ Processing = 'PROCESSING', /** Preview image is ready to be displayed. */ Ready = 'READY', /** Preview image processing has failed. */ Failed = 'FAILED' } /** The possible statuses for a media object. */ export enum MediaStatus { /** Media has been uploaded but not yet processed. */ Uploaded = 'UPLOADED', /** Media is being processed. */ Processing = 'PROCESSING', /** Media is ready to be displayed. */ Ready = 'READY', /** Media processing has failed. */ Failed = 'FAILED' } /** Represents an error that happens during execution of a Media query or mutation. */ export type MediaUserError = DisplayableError & { __typename?: 'MediaUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by MediaUserError. */ export enum MediaUserErrorCode { /** Input value is invalid. */ Invalid = 'INVALID', /** Input value is blank. */ Blank = 'BLANK', /** Video validation failed. */ VideoValidationError = 'VIDEO_VALIDATION_ERROR', /** Model validation failed. */ Model3DValidationError = 'MODEL3D_VALIDATION_ERROR', /** Video creation throttle was exceeded. */ VideoThrottleExceeded = 'VIDEO_THROTTLE_EXCEEDED', /** Model3d creation throttle was exceeded. */ Model3DThrottleExceeded = 'MODEL3D_THROTTLE_EXCEEDED', /** Exceeded the limit of media per product. */ ProductMediaLimitExceeded = 'PRODUCT_MEDIA_LIMIT_EXCEEDED', /** Exceeded the limit of media per shop. */ ShopMediaLimitExceeded = 'SHOP_MEDIA_LIMIT_EXCEEDED', /** Product does not exist. */ ProductDoesNotExist = 'PRODUCT_DOES_NOT_EXIST', /** Media does not exist. */ MediaDoesNotExist = 'MEDIA_DOES_NOT_EXIST', /** Media does not exist on the given product. */ MediaDoesNotExistOnProduct = 'MEDIA_DOES_NOT_EXIST_ON_PRODUCT', /** Only one mediaId is allowed per variant-media input pair. */ TooManyMediaPerInputPair = 'TOO_MANY_MEDIA_PER_INPUT_PAIR', /** Exceeded the maximum number of 100 variant-media pairs per mutation call. */ MaximumVariantMediaPairsExceeded = 'MAXIMUM_VARIANT_MEDIA_PAIRS_EXCEEDED', /** Invalid media type. */ InvalidMediaType = 'INVALID_MEDIA_TYPE', /** Variant specified in more than one pair. */ ProductVariantSpecifiedMultipleTimes = 'PRODUCT_VARIANT_SPECIFIED_MULTIPLE_TIMES', /** Variant does not exist on the given product. */ ProductVariantDoesNotExistOnProduct = 'PRODUCT_VARIANT_DOES_NOT_EXIST_ON_PRODUCT', /** Non-ready media are not supported. */ NonReadyMedia = 'NON_READY_MEDIA', /** Product variant already has attached media. */ ProductVariantAlreadyHasMedia = 'PRODUCT_VARIANT_ALREADY_HAS_MEDIA', /** The specified media is not attached to the specified variant. */ MediaIsNotAttachedToVariant = 'MEDIA_IS_NOT_ATTACHED_TO_VARIANT', /** Media cannot be modified. It is currently being modified by another operation. */ MediaCannotBeModified = 'MEDIA_CANNOT_BE_MODIFIED' } /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * composed of keys, values, and value types. */ export type Metafield = Node & LegacyInteroperability & { __typename?: 'Metafield'; /** The date and time when the metafield was created. */ createdAt: Scalars['DateTime']; /** The description of a metafield. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The key name for a metafield. */ key: Scalars['String']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The namespace for a metafield. */ namespace: Scalars['String']; /** Owner type of a metafield visible to the Storefront API. */ ownerType: MetafieldOwnerType; /** The date and time when the metafield was updated. */ updatedAt: Scalars['DateTime']; /** The value of a metafield. */ value: Scalars['String']; /** Represents the metafield value type. */ valueType: MetafieldValueType; }; /** An auto-generated type for paginating through multiple Metafields. */ export type MetafieldConnection = { __typename?: 'MetafieldConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Specifies the input fields to delete a metafield. */ export type MetafieldDeleteInput = { /** The ID of the metafield to delete. */ id: Scalars['ID']; }; /** Return type for `metafieldDelete` mutation. */ export type MetafieldDeletePayload = { __typename?: 'MetafieldDeletePayload'; /** The ID of the deleted metafield. */ deletedId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one Metafield and a cursor during pagination. */ export type MetafieldEdge = { __typename?: 'MetafieldEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of MetafieldEdge. */ node: Metafield; }; /** Specifies the input fields for a metafield. */ export type MetafieldInput = { /** The description of the metafield . */ description?: Maybe; /** The unique ID of the metafield. */ id?: Maybe; /** The key name of the metafield. */ key?: Maybe; /** The namespace for a metafield. */ namespace?: Maybe; /** The value of a metafield. */ value?: Maybe; /** The value type of a metafield. */ valueType?: Maybe; }; /** Possible types of a metafield's owner resource. */ export enum MetafieldOwnerType { /** The Article metafield owner type. */ Article = 'ARTICLE', /** The Blog metafield owner type. */ Blog = 'BLOG', /** The Collection metafield owner type. */ Collection = 'COLLECTION', /** The Customer metafield owner type. */ Customer = 'CUSTOMER', /** The Draft Order metafield owner type. */ Draftorder = 'DRAFTORDER', /** The Order metafield owner type. */ Order = 'ORDER', /** The Page metafield owner type. */ Page = 'PAGE', /** The Product metafield owner type. */ Product = 'PRODUCT', /** The Product Image metafield owner type. */ Productimage = 'PRODUCTIMAGE', /** The Product Variant metafield owner type. */ Productvariant = 'PRODUCTVARIANT', /** The Shop metafield owner type. */ Shop = 'SHOP' } /** Represents an allowlist record that enables a metafield to be visible to the storefront. */ export type MetafieldStorefrontVisibility = Node & LegacyInteroperability & { __typename?: 'MetafieldStorefrontVisibility'; /** The date and time when the allowlist record was created. */ createdAt: Scalars['DateTime']; /** Globally unique identifier. */ id: Scalars['ID']; /** Key of a metafield in the visibility allowlist. */ key: Scalars['String']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** Namespace of a metafield in the visibility allowlist. */ namespace: Scalars['String']; /** Owner type of a metafield in the visibility allowlist. */ ownerType: MetafieldOwnerType; /** The date and time when the allowlist record was updated. */ updatedAt: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple MetafieldStorefrontVisibilities. */ export type MetafieldStorefrontVisibilityConnection = { __typename?: 'MetafieldStorefrontVisibilityConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `metafieldStorefrontVisibilityCreate` mutation. */ export type MetafieldStorefrontVisibilityCreatePayload = { __typename?: 'MetafieldStorefrontVisibilityCreatePayload'; /** The metafield storefront visibility that was created. */ metafieldStorefrontVisibility?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `metafieldStorefrontVisibilityDelete` mutation. */ export type MetafieldStorefrontVisibilityDeletePayload = { __typename?: 'MetafieldStorefrontVisibilityDeletePayload'; /** The ID of the deleted metafield storefront visibility. */ deletedMetafieldStorefrontVisibilityId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one MetafieldStorefrontVisibility and a cursor during pagination. */ export type MetafieldStorefrontVisibilityEdge = { __typename?: 'MetafieldStorefrontVisibilityEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of MetafieldStorefrontVisibilityEdge. */ node: MetafieldStorefrontVisibility; }; /** Specifies the input fields for a MetafieldStorefrontVisibilityInput. */ export type MetafieldStorefrontVisibilityInput = { /** The namespace of the metafield to be visible to the storefront api. */ namespace: Scalars['String']; /** The key of the metafield to be visible to the storefront api. */ key: Scalars['String']; /** The core resource ( e.g.: Product ) that owns this metafield. */ ownerType: MetafieldOwnerType; }; /** Metafield value types. */ export enum MetafieldValueType { /** A string. */ String = 'STRING', /** An integer. */ Integer = 'INTEGER', /** A JSON string. */ JsonString = 'JSON_STRING' } /** The set of valid sort keys for the MethodDefinition query. */ export enum MethodDefinitionSortKeys { /** Sort by the `rate_provider_type` value. */ RateProviderType = 'RATE_PROVIDER_TYPE', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Represents a Shopify hosted 3D model. */ export type Model3d = Node & Media & { __typename?: 'Model3d'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** The filename of the 3d model. */ filename: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The media content type. */ mediaContentType: MediaContentType; /** Any errors which have occurred on the media. */ mediaErrors: Array; /** The original source for a 3d model. */ originalSource?: Maybe; /** The preview image for the media. */ preview?: Maybe; /** The sources for a 3d model. */ sources: Array; /** Current status of the media. */ status: MediaStatus; }; /** Represents a source for a Shopify hosted 3d model. */ export type Model3dSource = { __typename?: 'Model3dSource'; /** The filesize of the 3d model. */ filesize: Scalars['Int']; /** The format of the 3d model. */ format: Scalars['String']; /** The MIME type of the 3d model. */ mimeType: Scalars['String']; /** The URL of the 3d model. */ url: Scalars['String']; }; /** A collection of monetary values in their respective currencies. */ export type MoneyBag = { __typename?: 'MoneyBag'; /** Amount in presentment currency. */ presentmentMoney: MoneyV2; /** Amount in shop currency. */ shopMoney: MoneyV2; }; /** Specifies the fields for a monetary value with currency. */ export type MoneyInput = { /** Decimal money amount. */ amount: Scalars['Decimal']; /** Currency of the money. */ currencyCode: CurrencyCode; }; /** * A monetary value with currency. * * To format currencies, combine this type's amount and currencyCode fields with your client's locale. * * For example, in JavaScript you could use Intl.NumberFormat: * * ```js * new Intl.NumberFormat(locale, { * style: 'currency', * currency: currencyCode * }).format(amount); * ``` * * Other formatting libraries include: * * * iOS - [NumberFormatter](https://developer.apple.com/documentation/foundation/numberformatter) * * Android - [NumberFormat](https://developer.android.com/reference/java/text/NumberFormat.html) * * PHP - [NumberFormatter](http://php.net/manual/en/class.numberformatter.php) * * For a more general solution, the [Unicode CLDR number formatting database] is available with many implementations * (such as [TwitterCldr](https://github.com/twitter/twitter-cldr-rb)). */ export type MoneyV2 = { __typename?: 'MoneyV2'; /** Decimal money amount. */ amount: Scalars['Decimal']; /** Currency of the money. */ currencyCode: CurrencyCode; }; /** An individual move to perform of an object to a position. */ export type MoveInput = { /** The ID of the object to be moved. */ id: Scalars['ID']; /** The new position of the object in the set, using a 0 based index. */ newPosition: Scalars['UnsignedInt64']; }; /** The schema's entry point for all mutation operations. */ export type Mutation = { __typename?: 'Mutation'; /** Allows an app to create a credit for a shop that can be used towards future app purchases. */ appCreditCreate?: Maybe; /** Allows an app to charge a shop for features or services one time. */ appPurchaseOneTimeCreate?: Maybe; /** Creates a record of the attributed revenue for the app. This mutation should only be used to capture transactions that are not managed by the Billing API. */ appRevenueAttributionRecordCreate?: Maybe; /** Deletes a record of the attributed revenue for the app. */ appRevenueAttributionRecordDelete?: Maybe; /** Cancels an app subscription on a store. */ appSubscriptionCancel?: Maybe; /** Allows an app to charge a store for features or services on a recurring basis. */ appSubscriptionCreate?: Maybe; /** Updates the app plan's pricing details attached to an app subscription. */ appSubscriptionLineItemUpdate?: Maybe; /** Allows an app to charge a store for usage. */ appUsageRecordCreate?: Maybe; /** * Starts the cancelation process of a running bulk operation. * * There may be a short delay from when a cancelation starts until the operation is actually canceled. */ bulkOperationCancel?: Maybe; /** * Creates and runs a bulk operation query. * * See the [bulk operations guide](https://help.shopify.com/api/guides/bulk-operations) for more details. */ bulkOperationRunQuery?: Maybe; /** Adds products to a collection. */ collectionAddProducts?: Maybe; /** Creates a collection. */ collectionCreate?: Maybe; /** Deletes a collection. */ collectionDelete?: Maybe; /** * Publishes a collection to a channel. * @deprecated Use `publishablePublish` instead */ collectionPublish?: Maybe; /** Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled. */ collectionRemoveProducts?: Maybe; /** Asynchronously reorders a set of products from a given collection. */ collectionReorderProducts?: Maybe; /** * Unpublishes a collection. * @deprecated Use `publishableUnpublish` instead */ collectionUnpublish?: Maybe; /** Updates a collection. */ collectionUpdate?: Maybe; /** Add tax exemptions to a customer. */ customerAddTaxExemptions?: Maybe; /** Creates a new customer. */ customerCreate?: Maybe; /** Deletes a customer. */ customerDelete?: Maybe; /** Generates a new account activation URL. */ customerGenerateAccountActivationUrl?: Maybe; /** Creates a credit card payment method for a customer. */ customerPaymentMethodCreditCardCreate?: Maybe; /** Updates the credit card payment method for a customer. */ customerPaymentMethodCreditCardUpdate?: Maybe; /** Create a payment method from a credit card stored by Stripe. */ customerPaymentMethodRemoteCreditCardCreate?: Maybe; /** Revokes a customer's payment method. */ customerPaymentMethodRevoke?: Maybe; /** Sends a link to the customer so they can update a specific payment method. */ customerPaymentMethodSendUpdateEmail?: Maybe; /** Remove tax exemptions from a customer. */ customerRemoveTaxExemptions?: Maybe; /** Replace tax exemptions on a customer. */ customerReplaceTaxExemptions?: Maybe; /** Updates a customer's attributes. */ customerUpdate?: Maybe; /** Updates a customer's default address. */ customerUpdateDefaultAddress?: Maybe; /** Creates a delivery profile. */ deliveryProfileCreate?: Maybe; /** Enqueues the deletion/removal of a delivery profile. */ deliveryProfileRemove?: Maybe; /** Updates a delivery profile. */ deliveryProfileUpdate?: Maybe; /** Set the delivery settings for a shop. */ deliverySettingUpdate?: Maybe; /** Assign a location as the shipping origin while in legacy compatibility mode profiles. */ deliveryShippingOriginAssign?: Maybe; /** Activates an automatic discount. */ discountAutomaticActivate?: Maybe; /** Creates a basic automatic discount. */ discountAutomaticBasicCreate?: Maybe; /** Updates a basic automatic discount using its ID and input. */ discountAutomaticBasicUpdate?: Maybe; /** * Asynchronously delete automatic discounts in bulk if a `search` or `saved_search_id` argument is provided or if a * maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. * **Warning:** All automatic discounts will be deleted if a blank `search` argument is provided. */ discountAutomaticBulkDelete?: Maybe; /** Creates a BXGY automatic discount. */ discountAutomaticBxgyCreate?: Maybe; /** Updates a BXGY automatic discount using its ID and input. */ discountAutomaticBxgyUpdate?: Maybe; /** Deactivates an automatic discount. */ discountAutomaticDeactivate?: Maybe; /** Deletes an automatic discount. */ discountAutomaticDelete?: Maybe; /** Activates a code discount. */ discountCodeActivate?: Maybe; /** Creates a basic code discount. */ discountCodeBasicCreate?: Maybe; /** Updates a basic code discount. */ discountCodeBasicUpdate?: Maybe; /** Asynchronously activate code discounts in bulk using a search query, a `savedSearchId` or a list of IDs. */ discountCodeBulkActivate?: Maybe; /** Asynchronously deactivates code discounts in bulk using a search query, a `savedSearchId` or a list of IDs. */ discountCodeBulkDeactivate?: Maybe; /** Asynchronously delete code discounts in bulk using a search query, a `savedSearchId` or a list of IDs. */ discountCodeBulkDelete?: Maybe; /** Creates a BXGY code discount. */ discountCodeBxgyCreate?: Maybe; /** Updates a BXGY code discount. */ discountCodeBxgyUpdate?: Maybe; /** Deactivates a code discount. */ discountCodeDeactivate?: Maybe; /** Deletes a code discount. */ discountCodeDelete?: Maybe; /** Creates a free shipping code discount. */ discountCodeFreeShippingCreate?: Maybe; /** Updates a free shipping code discount. */ discountCodeFreeShippingUpdate?: Maybe; /** * Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a * search query, a `savedSearchId`, or a list of redeem code IDs. */ discountCodeRedeemCodeBulkDelete?: Maybe; /** * Asynchronously add discount redeem codes in bulk. Specify the codes to add * and the discount code ID that the codes will belong to. */ discountRedeemCodeBulkAdd?: Maybe; /** * Calculates the properties of a draft order. Useful for determining information * such as total taxes or price without actually creating a draft order. */ draftOrderCalculate?: Maybe; /** Completes a draft order and creates an order. */ draftOrderComplete?: Maybe; /** Creates a draft order. */ draftOrderCreate?: Maybe; /** Deletes a draft order. */ draftOrderDelete?: Maybe; /** Previews a draft order invoice email. */ draftOrderInvoicePreview?: Maybe; /** Sends an email invoice for a draft order. */ draftOrderInvoiceSend?: Maybe; /** Updates a draft order. */ draftOrderUpdate?: Maybe; /** Creates a new Amazon EventBridge webhook subscription. */ eventBridgeWebhookSubscriptionCreate?: Maybe; /** Updates an Amazon EventBridge webhook subscription. */ eventBridgeWebhookSubscriptionUpdate?: Maybe; /** Triggers a workflow defined by the merchant in Shopify Flow. To learn more, see [_Create Shopify Flow triggers_](https://help.shopify.com/api/embedded-apps/app-extensions/flow/create-triggers). */ flowTriggerReceive?: Maybe; /** Cancels a fulfillment. */ fulfillmentCancel?: Maybe; /** * Creates a fulfillment for an order. * @deprecated Use the new [fulfillmentOrder](https://shopify.dev/tutorials/manage-fulfillments-with-fulfillment-and-fulfillmentorder-resources) APIs to manage fulfillments. */ fulfillmentCreate?: Maybe; /** * Creates a fulfillment for one or many fulfillment orders. * The fulfillment orders are associated with the same order and are assigned to the same location. */ fulfillmentCreateV2?: Maybe; /** Accept a cancellation request sent to a fulfillment service for a fulfillment order. */ fulfillmentOrderAcceptCancellationRequest?: Maybe; /** Accepts a fulfillment request sent to a fulfillment service for a fulfillment order. */ fulfillmentOrderAcceptFulfillmentRequest?: Maybe; /** Marks a fulfillment order as canceled. */ fulfillmentOrderCancel?: Maybe; /** Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order. */ fulfillmentOrderClose?: Maybe; /** Moves a fulfillment order to a new location. */ fulfillmentOrderMove?: Maybe; /** Marks a scheduled fulfillment order as open. */ fulfillmentOrderOpen?: Maybe; /** Rejects a cancellation request sent to a fulfillment service for a fulfillment order. */ fulfillmentOrderRejectCancellationRequest?: Maybe; /** Rejects a fulfillment request sent to a fulfillment service for a fulfillment order. */ fulfillmentOrderRejectFulfillmentRequest?: Maybe; /** Reschedules a scheduled fulfillment order. */ fulfillmentOrderReschedule?: Maybe; /** Sends a cancellation request to the fulfillment service of a fulfillment order. */ fulfillmentOrderSubmitCancellationRequest?: Maybe; /** Sends a fulfillment request to the fulfillment service of a fulfillment order. */ fulfillmentOrderSubmitFulfillmentRequest?: Maybe; /** Creates a fulfillment service. */ fulfillmentServiceCreate?: Maybe; /** Deletes a fulfillment service. */ fulfillmentServiceDelete?: Maybe; /** Updates a fulfillment service. */ fulfillmentServiceUpdate?: Maybe; /** * Updates tracking information for a fulfillment. * @deprecated Use the new [fulfillmentOrder](https://shopify.dev/tutorials/manage-fulfillments-with-fulfillment-and-fulfillmentorder-resources) APIs to manage fulfillments. */ fulfillmentTrackingInfoUpdate?: Maybe; /** Updates tracking information for a fulfillment. */ fulfillmentTrackingInfoUpdateV2?: Maybe; /** Creates a gift card. */ giftCardCreate?: Maybe; /** Disable a gift card. */ giftCardDisable?: Maybe; /** Update a gift card. */ giftCardUpdate?: Maybe; /** Activate an inventory item at a location. */ inventoryActivate?: Maybe; /** Adjusts the inventory by a certain quantity. */ inventoryAdjustQuantity?: Maybe; /** Adjusts the inventory at a location for multiple inventory items. */ inventoryBulkAdjustQuantityAtLocation?: Maybe; /** Deactivate an inventory item at a location. */ inventoryDeactivate?: Maybe; /** Updates an inventory item. */ inventoryItemUpdate?: Maybe; /** * Kit Skill requested by developer for app and shop. * @deprecated Kit Skills will be deprecated as of 2021-04-01. */ kitSkillTriggerRequest?: Maybe; /** Create new marketing activity. */ marketingActivityCreate?: Maybe; /** Updates a marketing activity. */ marketingActivityUpdate?: Maybe; /** Creates a new marketing event engagement for a marketing activity. */ marketingEngagementCreate?: Maybe; /** Deletes a metafield. */ metafieldDelete?: Maybe; /** Makes a Metafield with a specific namespace and key visible to the storefront API. */ metafieldStorefrontVisibilityCreate?: Maybe; /** Deletes a Metafield Storefront Visibility. */ metafieldStorefrontVisibilityDelete?: Maybe; /** Captures from an authorized transaction on an order. */ orderCapture?: Maybe; /** Closes an open order. */ orderClose?: Maybe; /** Add a custom line item to an existing order. For example, you might want to add gift wrapping service as a [custom line item](https://shopify.dev/tutorials/edit-an-existing-order-with-admin-api#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/tutorials/edit-an-existing-order-with-admin-api). */ orderEditAddCustomItem?: Maybe; /** Add a discount to an item added during this order edit. */ orderEditAddLineItemDiscount?: Maybe; /** Add a line item from an existing product variant. */ orderEditAddVariant?: Maybe; /** Start editing an order. */ orderEditBegin?: Maybe; /** Applies and saves staged changes to an order. */ orderEditCommit?: Maybe; /** Removes a discount that was added as part of this edit. */ orderEditRemoveLineItemDiscount?: Maybe; /** Set the quantity of an item on the order. */ orderEditSetQuantity?: Maybe; /** Marks an order as paid. */ orderMarkAsPaid?: Maybe; /** Opens a closed order. */ orderOpen?: Maybe; /** Updates an order. */ orderUpdate?: Maybe; /** * Rejects an open payment session. * After the `paymentSessionReject` mutation completes on a given payment session, any * `paymentSessionResolve` mutation attempts will fail. Subsequent `paymentSessionReject` * mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. */ paymentSessionReject?: Maybe; /** * Resolves an open payment session. * After the `paymentSessionResolve` mutation completes on a given payment session, any * `paymentSessionReject` mutation attempts will fail. Subsequent `paymentSessionResolve` * mutation attempts will succeed, but the `Details` argument will be ignored. */ paymentSessionResolve?: Maybe; /** Configure the partner managed gateway onto the merchant's store. */ paymentsAppConfigure?: Maybe; /** Create a price list. You can use the `priceListCreate` mutation to create a new price list for a country. This lets you sell your products with international pricing. */ priceListCreate?: Maybe; /** Delete a price list. You can use the `priceListDelete` mutation to delete a price list, so that it no longer applies for products in that country. To delete a price list, you need to specify the price list ID. */ priceListDelete?: Maybe; /** Creates or updates fixed prices on a price list. You can use the `priceListFixedPricesAdd` mutation to set a fixed price for specific product variants. This lets you change product variant pricing on a per country basis. Any existing fixed price list prices for these variants will be overwritten. */ priceListFixedPricesAdd?: Maybe; /** Deletes specific prices from a price list using a product variant ID. You can use the `priceListFixedPricesDelete` mutation to delete a partial set of prices on a price list. After deletion, the prices no longer apply for products in the country. */ priceListFixedPricesDelete?: Maybe; /** Update a price list. You can update a price list to make changes to percentage-based price adjustments. You can use the `priceListUpdate` mutation to update an existing price list for a country. This lets you change product pricing on a per country basis. As part of the mutation, you can change the name, percentage-based adjustment, currency, and country. */ priceListUpdate?: Maybe; /** Activate a price rule. */ priceRuleActivate?: Maybe; /** Create a price rule using the input. */ priceRuleCreate?: Maybe; /** Deactivate a price rule. */ priceRuleDeactivate?: Maybe; /** Delete a price rule. */ priceRuleDelete?: Maybe; /** Create a discount code for a price rule. */ priceRuleDiscountCodeCreate?: Maybe; /** Update a discount code for a price rule. */ priceRuleDiscountCodeUpdate?: Maybe; /** Update a price rule using its id and an input. */ priceRuleUpdate?: Maybe; /** Deletes a private metafield. */ privateMetafieldDelete?: Maybe; /** Creates or update a private metafield. */ privateMetafieldUpsert?: Maybe; /** Appends images to a product. */ productAppendImages?: Maybe; /** Change status of a product. */ productChangeStatus?: Maybe; /** Creates a product. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can only be created on online stores. */ productCreate?: Maybe; /** Creates media for a product. */ productCreateMedia?: Maybe; /** Deletes a product. */ productDelete?: Maybe; /** Removes a product images from the product. */ productDeleteImages?: Maybe; /** Deletes media for a product. */ productDeleteMedia?: Maybe; /** Duplicates a product. */ productDuplicate?: Maybe; /** Updates an image of a product. */ productImageUpdate?: Maybe; /** Adds multiple selling plan groups to a product. */ productJoinSellingPlanGroups?: Maybe; /** Removes multiple groups from a product. */ productLeaveSellingPlanGroups?: Maybe; /** * Publishes a product. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can only be published on online stores. * @deprecated Use `publishablePublish` instead */ productPublish?: Maybe; /** Asynchronously reorders a set of images for a given product. */ productReorderImages?: Maybe; /** Asynchronously Reoders the media attached to a product. */ productReorderMedia?: Maybe; /** * Unpublishes a product. * @deprecated Use `publishableUnpublish` instead */ productUnpublish?: Maybe; /** * Updates a product. If you update a product, and only some variants are included in the update, * then any variants not included will be deleted. If you want to update a single variant, then use * [productVariantUpdate](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariantupdate). * Products that are sold exclusively on subscription (`requiresSellingPlan: true`) * can be updated only on online stores. If you update a product to be sold only on a subscription, * then the product is unpublished from all channels except the online store. */ productUpdate?: Maybe; /** Updates media for a product. */ productUpdateMedia?: Maybe; /** Appends media from a product to variants of the product. */ productVariantAppendMedia?: Maybe; /** Creates a product variant. */ productVariantCreate?: Maybe; /** Deletes a product variant. */ productVariantDelete?: Maybe; /** Deletes media from product variants. */ productVariantDetachMedia?: Maybe; /** Adds multiple selling plan groups to a product variant. */ productVariantJoinSellingPlanGroups?: Maybe; /** Remove multiple groups from a product variant. */ productVariantLeaveSellingPlanGroups?: Maybe; /** Updates a product variant. */ productVariantUpdate?: Maybe; /** Publishes a resource to a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores. */ publishablePublish?: Maybe; /** Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores. */ publishablePublishToCurrentChannel?: Maybe; /** Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. */ publishableUnpublish?: Maybe; /** Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. */ publishableUnpublishToCurrentChannel?: Maybe; /** Creates a refund. */ refundCreate?: Maybe; /** * Rejects an open refund session. * After the `refundSessionReject` mutation completes on a given refund session, any * `refundSessionResolve` mutation attempts will fail. Subsequent `refundSessionReject` * mutation attempts will succeed, but the `RejectionReasonInput` argument will be ignored. */ refundSessionReject?: Maybe; /** * Resolves an open refund session. * After the `refundSessionResolve` mutation completes on a given refund session, any * `refundSessionReject` mutation attempts will fail. Subsequent `refundSessionResolve` * mutation attempts will succeed, but the `Details` argument will be ignored. */ refundSessionResolve?: Maybe; /** Creates a saved search. */ savedSearchCreate?: Maybe; /** Delete a saved search. */ savedSearchDelete?: Maybe; /** Update a saved search. */ savedSearchUpdate?: Maybe; /** Creates a new script tag. */ scriptTagCreate?: Maybe; /** Deletes a script tag. */ scriptTagDelete?: Maybe; /** Updates a script tag. */ scriptTagUpdate?: Maybe; /** Adds multiple product variants to a selling plan group. */ sellingPlanGroupAddProductVariants?: Maybe; /** Adds multiple products to a selling plan group. */ sellingPlanGroupAddProducts?: Maybe; /** Creates a Selling Plan Group. */ sellingPlanGroupCreate?: Maybe; /** Delete a Selling Plan Group. */ sellingPlanGroupDelete?: Maybe; /** Removes multiple product variants from a selling plan group. */ sellingPlanGroupRemoveProductVariants?: Maybe; /** Removes multiple products from a selling plan group. */ sellingPlanGroupRemoveProducts?: Maybe; /** Update a Selling Plan Group. */ sellingPlanGroupUpdate?: Maybe; /** Deletes a shipping package. */ shippingPackageDelete?: Maybe; /** Sets a Shipping Package as the default shipping package. The default shipping package is the one used to calculate shipping costs on checkout. */ shippingPackageMakeDefault?: Maybe; /** Updates a custom shipping package. */ shippingPackageUpdate?: Maybe; /** Disables a locale for a shop. */ shopLocaleDisable?: Maybe; /** Enables a locale for a shop. */ shopLocaleEnable?: Maybe; /** Updates a locale for a shop. */ shopLocaleUpdate?: Maybe; /** Updates a shop policy. */ shopPolicyUpdate?: Maybe; /** * Generates the URL and signed paramaters needed to upload an asset to Shopify. * @deprecated Use `stagedUploadsCreate` instead */ stagedUploadTargetGenerate?: Maybe; /** * Uploads multiple images. * @deprecated Use `stagedUploadsCreate` instead */ stagedUploadTargetsGenerate?: Maybe; /** Creates staged upload target URLs for each input and is the first step in the upload process. The returned upload targets with URLs can be used as endpoints to upload the files. */ stagedUploadsCreate?: Maybe; /** Creates a storefront access token. */ storefrontAccessTokenCreate?: Maybe; /** Deletes a storefront access token. */ storefrontAccessTokenDelete?: Maybe; /** Creates a new subscription billing attempt. */ subscriptionBillingAttemptCreate?: Maybe; /** Creates a Subscription Contract. */ subscriptionContractCreate?: Maybe; /** Sets the next billing date of a Subscription Contract. */ subscriptionContractSetNextBillingDate?: Maybe; /** Updates a Subscription Contract. */ subscriptionContractUpdate?: Maybe; /** Commits the updates of a Subscription Contract draft. */ subscriptionDraftCommit?: Maybe; /** Adds a subscription discount to a subscription draft. */ subscriptionDraftDiscountAdd?: Maybe; /** Applies a code discount on the subscription draft. */ subscriptionDraftDiscountCodeApply?: Maybe; /** Removes a subscription discount from a subscription draft. */ subscriptionDraftDiscountRemove?: Maybe; /** Updates a subscription discount on a subscription draft. */ subscriptionDraftDiscountUpdate?: Maybe; /** Adds a subscription free shipping discount to a subscription draft. */ subscriptionDraftFreeShippingDiscountAdd?: Maybe; /** Updates a subscription free shipping discount on a subscription draft. */ subscriptionDraftFreeShippingDiscountUpdate?: Maybe; /** Adds a subscription line to a subscription draft. */ subscriptionDraftLineAdd?: Maybe; /** Removes a subscription line from a subscription draft. */ subscriptionDraftLineRemove?: Maybe; /** Updates a subscription line on a subscription draft. */ subscriptionDraftLineUpdate?: Maybe; /** Updates a Subscription Draft. */ subscriptionDraftUpdate?: Maybe; /** Add tags to an order, a draft order, a customer, a product, or an online store article. */ tagsAdd?: Maybe; /** Remove tags from a taggable object. */ tagsRemove?: Maybe; /** Creates or updates translations. */ translationsRegister?: Maybe; /** Removes translations. */ translationsRemove?: Maybe; /** Creates a new webhook subscription. */ webhookSubscriptionCreate?: Maybe; /** Deletes a webhook subscription. */ webhookSubscriptionDelete?: Maybe; /** Updates a webhook subscription. */ webhookSubscriptionUpdate?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationAppCreditCreateArgs = { description: Scalars['String']; amount: MoneyInput; test?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationAppPurchaseOneTimeCreateArgs = { name: Scalars['String']; price: MoneyInput; returnUrl: Scalars['URL']; test?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationAppRevenueAttributionRecordCreateArgs = { appRevenueAttributionRecord: AppRevenueAttributionRecordInput; }; /** The schema's entry point for all mutation operations. */ export type MutationAppRevenueAttributionRecordDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationAppSubscriptionCancelArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationAppSubscriptionCreateArgs = { name: Scalars['String']; lineItems: Array; test?: Maybe; trialDays?: Maybe; returnUrl: Scalars['URL']; }; /** The schema's entry point for all mutation operations. */ export type MutationAppSubscriptionLineItemUpdateArgs = { id: Scalars['ID']; cappedAmount: MoneyInput; }; /** The schema's entry point for all mutation operations. */ export type MutationAppUsageRecordCreateArgs = { subscriptionLineItemId: Scalars['ID']; price: MoneyInput; description: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationBulkOperationCancelArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationBulkOperationRunQueryArgs = { query: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionAddProductsArgs = { id: Scalars['ID']; productIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionCreateArgs = { input: CollectionInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionDeleteArgs = { input: CollectionDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionPublishArgs = { input: CollectionPublishInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionRemoveProductsArgs = { id: Scalars['ID']; productIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionReorderProductsArgs = { id: Scalars['ID']; moves: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionUnpublishArgs = { input: CollectionUnpublishInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCollectionUpdateArgs = { input: CollectionInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerAddTaxExemptionsArgs = { customerId: Scalars['ID']; taxExemptions: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerCreateArgs = { input: CustomerInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerDeleteArgs = { input: CustomerDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerGenerateAccountActivationUrlArgs = { customerId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerPaymentMethodCreditCardCreateArgs = { customerId: Scalars['ID']; billingAddress: MailingAddressInput; sessionId: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerPaymentMethodCreditCardUpdateArgs = { id: Scalars['ID']; billingAddress: MailingAddressInput; sessionId: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerPaymentMethodRemoteCreditCardCreateArgs = { customerId: Scalars['ID']; stripeCustomerId: Scalars['String']; stripePaymentMethodId?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerPaymentMethodRevokeArgs = { customerPaymentMethodId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerPaymentMethodSendUpdateEmailArgs = { customerPaymentMethodId: Scalars['ID']; email?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerRemoveTaxExemptionsArgs = { customerId: Scalars['ID']; taxExemptions: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerReplaceTaxExemptionsArgs = { customerId: Scalars['ID']; taxExemptions: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerUpdateArgs = { input: CustomerInput; }; /** The schema's entry point for all mutation operations. */ export type MutationCustomerUpdateDefaultAddressArgs = { customerId: Scalars['ID']; addressId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDeliveryProfileCreateArgs = { profile: DeliveryProfileInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDeliveryProfileRemoveArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDeliveryProfileUpdateArgs = { id: Scalars['ID']; profile: DeliveryProfileInput; leaveLegacyModeProfiles?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationDeliverySettingUpdateArgs = { setting: DeliverySettingInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDeliveryShippingOriginAssignArgs = { locationId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticActivateArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticBasicCreateArgs = { automaticBasicDiscount: DiscountAutomaticBasicInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticBasicUpdateArgs = { id: Scalars['ID']; automaticBasicDiscount: DiscountAutomaticBasicInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticBulkDeleteArgs = { search?: Maybe; savedSearchId?: Maybe; ids?: Maybe>; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticBxgyCreateArgs = { automaticBxgyDiscount: DiscountAutomaticBxgyInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticBxgyUpdateArgs = { id: Scalars['ID']; automaticBxgyDiscount: DiscountAutomaticBxgyInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticDeactivateArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountAutomaticDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeActivateArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeBasicCreateArgs = { basicCodeDiscount: DiscountCodeBasicInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeBasicUpdateArgs = { id: Scalars['ID']; basicCodeDiscount: DiscountCodeBasicInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeBulkActivateArgs = { search?: Maybe; savedSearchId?: Maybe; ids?: Maybe>; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeBulkDeactivateArgs = { search?: Maybe; savedSearchId?: Maybe; ids?: Maybe>; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeBulkDeleteArgs = { search?: Maybe; savedSearchId?: Maybe; ids?: Maybe>; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeBxgyCreateArgs = { bxgyCodeDiscount: DiscountCodeBxgyInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeBxgyUpdateArgs = { id: Scalars['ID']; bxgyCodeDiscount: DiscountCodeBxgyInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeDeactivateArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeFreeShippingCreateArgs = { freeShippingCodeDiscount: DiscountCodeFreeShippingInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeFreeShippingUpdateArgs = { id: Scalars['ID']; freeShippingCodeDiscount: DiscountCodeFreeShippingInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountCodeRedeemCodeBulkDeleteArgs = { discountId: Scalars['ID']; search?: Maybe; savedSearchId?: Maybe; ids?: Maybe>; }; /** The schema's entry point for all mutation operations. */ export type MutationDiscountRedeemCodeBulkAddArgs = { discountId: Scalars['ID']; codes: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationDraftOrderCalculateArgs = { input: DraftOrderInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDraftOrderCompleteArgs = { id: Scalars['ID']; paymentPending?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationDraftOrderCreateArgs = { input: DraftOrderInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDraftOrderDeleteArgs = { input: DraftOrderDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationDraftOrderInvoicePreviewArgs = { id: Scalars['ID']; email?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationDraftOrderInvoiceSendArgs = { id: Scalars['ID']; email?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationDraftOrderUpdateArgs = { id: Scalars['ID']; input: DraftOrderInput; }; /** The schema's entry point for all mutation operations. */ export type MutationEventBridgeWebhookSubscriptionCreateArgs = { topic: WebhookSubscriptionTopic; webhookSubscription: EventBridgeWebhookSubscriptionInput; }; /** The schema's entry point for all mutation operations. */ export type MutationEventBridgeWebhookSubscriptionUpdateArgs = { id: Scalars['ID']; webhookSubscription: EventBridgeWebhookSubscriptionInput; }; /** The schema's entry point for all mutation operations. */ export type MutationFlowTriggerReceiveArgs = { body: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentCancelArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentCreateArgs = { input: FulfillmentInput; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentCreateV2Args = { fulfillment: FulfillmentV2Input; message?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderAcceptCancellationRequestArgs = { id: Scalars['ID']; message?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderAcceptFulfillmentRequestArgs = { id: Scalars['ID']; message?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderCancelArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderCloseArgs = { id: Scalars['ID']; message?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderMoveArgs = { id: Scalars['ID']; newLocationId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderOpenArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderRejectCancellationRequestArgs = { id: Scalars['ID']; message?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderRejectFulfillmentRequestArgs = { id: Scalars['ID']; message?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderRescheduleArgs = { id: Scalars['ID']; fulfillAt: Scalars['DateTime']; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderSubmitCancellationRequestArgs = { id: Scalars['ID']; message?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentOrderSubmitFulfillmentRequestArgs = { id: Scalars['ID']; message?: Maybe; notifyCustomer?: Maybe; fulfillmentOrderLineItems?: Maybe>; shippingMethod?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentServiceCreateArgs = { name: Scalars['String']; callbackUrl?: Maybe; trackingSupport?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentServiceDeleteArgs = { id: Scalars['ID']; destinationLocationId?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentServiceUpdateArgs = { id: Scalars['ID']; name?: Maybe; callbackUrl?: Maybe; trackingSupport?: Maybe; fulfillmentOrdersOptIn?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentTrackingInfoUpdateArgs = { fulfillmentId: Scalars['ID']; trackingInfoUpdateInput: TrackingInfoUpdateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationFulfillmentTrackingInfoUpdateV2Args = { fulfillmentId: Scalars['ID']; trackingInfoInput: FulfillmentTrackingInput; notifyCustomer?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationGiftCardCreateArgs = { input: GiftCardCreateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationGiftCardDisableArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationGiftCardUpdateArgs = { id: Scalars['ID']; input: GiftCardUpdateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationInventoryActivateArgs = { inventoryItemId: Scalars['ID']; locationId: Scalars['ID']; available?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationInventoryAdjustQuantityArgs = { input: InventoryAdjustQuantityInput; }; /** The schema's entry point for all mutation operations. */ export type MutationInventoryBulkAdjustQuantityAtLocationArgs = { inventoryItemAdjustments: Array; locationId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationInventoryDeactivateArgs = { inventoryLevelId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationInventoryItemUpdateArgs = { id: Scalars['ID']; input: InventoryItemUpdateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationKitSkillTriggerRequestArgs = { id: Scalars['ID']; locale: KitSkillLocale; placeholders?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationMarketingActivityCreateArgs = { input: MarketingActivityCreateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationMarketingActivityUpdateArgs = { input: MarketingActivityUpdateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationMarketingEngagementCreateArgs = { marketingActivityId: Scalars['ID']; marketingEngagement: MarketingEngagementInput; }; /** The schema's entry point for all mutation operations. */ export type MutationMetafieldDeleteArgs = { input: MetafieldDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationMetafieldStorefrontVisibilityCreateArgs = { input: MetafieldStorefrontVisibilityInput; }; /** The schema's entry point for all mutation operations. */ export type MutationMetafieldStorefrontVisibilityDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderCaptureArgs = { input: OrderCaptureInput; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderCloseArgs = { input: OrderCloseInput; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderEditAddCustomItemArgs = { id: Scalars['ID']; title: Scalars['String']; locationId?: Maybe; price: MoneyInput; quantity: Scalars['Int']; taxable?: Maybe; requiresShipping?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderEditAddLineItemDiscountArgs = { id: Scalars['ID']; lineItemId: Scalars['ID']; discount: OrderEditAppliedDiscountInput; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderEditAddVariantArgs = { id: Scalars['ID']; variantId: Scalars['ID']; locationId?: Maybe; quantity: Scalars['Int']; allowDuplicates?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderEditBeginArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderEditCommitArgs = { id: Scalars['ID']; notifyCustomer?: Maybe; staffNote?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderEditRemoveLineItemDiscountArgs = { id: Scalars['ID']; discountApplicationId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderEditSetQuantityArgs = { id: Scalars['ID']; lineItemId: Scalars['ID']; quantity: Scalars['Int']; restock?: Maybe; locationId?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderMarkAsPaidArgs = { input: OrderMarkAsPaidInput; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderOpenArgs = { input: OrderOpenInput; }; /** The schema's entry point for all mutation operations. */ export type MutationOrderUpdateArgs = { input: OrderInput; }; /** The schema's entry point for all mutation operations. */ export type MutationPaymentSessionRejectArgs = { id: Scalars['ID']; reason: PaymentSessionRejectionReasonInput; }; /** The schema's entry point for all mutation operations. */ export type MutationPaymentSessionResolveArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationPaymentsAppConfigureArgs = { externalHandle?: Maybe; ready: Scalars['Boolean']; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceListCreateArgs = { input: PriceListCreateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceListDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceListFixedPricesAddArgs = { priceListId: Scalars['ID']; prices: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceListFixedPricesDeleteArgs = { priceListId: Scalars['ID']; variantIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceListUpdateArgs = { id: Scalars['ID']; input: PriceListUpdateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceRuleActivateArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceRuleCreateArgs = { priceRule: PriceRuleInput; priceRuleDiscountCode?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceRuleDeactivateArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceRuleDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceRuleDiscountCodeCreateArgs = { priceRuleId: Scalars['ID']; code: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceRuleDiscountCodeUpdateArgs = { priceRuleId: Scalars['ID']; code: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationPriceRuleUpdateArgs = { id: Scalars['ID']; priceRule: PriceRuleInput; priceRuleDiscountCode?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationPrivateMetafieldDeleteArgs = { input: PrivateMetafieldDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationPrivateMetafieldUpsertArgs = { input: PrivateMetafieldInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductAppendImagesArgs = { input: ProductAppendImagesInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductChangeStatusArgs = { productId: Scalars['ID']; status: ProductStatus; }; /** The schema's entry point for all mutation operations. */ export type MutationProductCreateArgs = { input: ProductInput; media?: Maybe>; }; /** The schema's entry point for all mutation operations. */ export type MutationProductCreateMediaArgs = { productId: Scalars['ID']; media: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductDeleteArgs = { input: ProductDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductDeleteImagesArgs = { id: Scalars['ID']; imageIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductDeleteMediaArgs = { productId: Scalars['ID']; mediaIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductDuplicateArgs = { productId: Scalars['ID']; newTitle: Scalars['String']; newStatus?: Maybe; includeImages?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationProductImageUpdateArgs = { productId: Scalars['ID']; image: ImageInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductJoinSellingPlanGroupsArgs = { id: Scalars['ID']; sellingPlanGroupIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductLeaveSellingPlanGroupsArgs = { id: Scalars['ID']; sellingPlanGroupIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductPublishArgs = { input: ProductPublishInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductReorderImagesArgs = { id: Scalars['ID']; moves: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductReorderMediaArgs = { id: Scalars['ID']; moves: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductUnpublishArgs = { input: ProductUnpublishInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductUpdateArgs = { input: ProductInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductUpdateMediaArgs = { productId: Scalars['ID']; media: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductVariantAppendMediaArgs = { productId: Scalars['ID']; variantMedia: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductVariantCreateArgs = { input: ProductVariantInput; }; /** The schema's entry point for all mutation operations. */ export type MutationProductVariantDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationProductVariantDetachMediaArgs = { productId: Scalars['ID']; variantMedia: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductVariantJoinSellingPlanGroupsArgs = { id: Scalars['ID']; sellingPlanGroupIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductVariantLeaveSellingPlanGroupsArgs = { id: Scalars['ID']; sellingPlanGroupIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationProductVariantUpdateArgs = { input: ProductVariantInput; }; /** The schema's entry point for all mutation operations. */ export type MutationPublishablePublishArgs = { id: Scalars['ID']; input: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationPublishablePublishToCurrentChannelArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationPublishableUnpublishArgs = { id: Scalars['ID']; input: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationPublishableUnpublishToCurrentChannelArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationRefundCreateArgs = { input: RefundInput; }; /** The schema's entry point for all mutation operations. */ export type MutationRefundSessionRejectArgs = { id: Scalars['ID']; reason: RefundSessionRejectionReasonInput; }; /** The schema's entry point for all mutation operations. */ export type MutationRefundSessionResolveArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationSavedSearchCreateArgs = { input: SavedSearchCreateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSavedSearchDeleteArgs = { input: SavedSearchDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSavedSearchUpdateArgs = { input: SavedSearchUpdateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationScriptTagCreateArgs = { input: ScriptTagInput; }; /** The schema's entry point for all mutation operations. */ export type MutationScriptTagDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationScriptTagUpdateArgs = { id: Scalars['ID']; input: ScriptTagInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSellingPlanGroupAddProductVariantsArgs = { id: Scalars['ID']; productVariantIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationSellingPlanGroupAddProductsArgs = { id: Scalars['ID']; productIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationSellingPlanGroupCreateArgs = { input: SellingPlanGroupInput; resources?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationSellingPlanGroupDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationSellingPlanGroupRemoveProductVariantsArgs = { id: Scalars['ID']; productVariantIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationSellingPlanGroupRemoveProductsArgs = { id: Scalars['ID']; productIds: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationSellingPlanGroupUpdateArgs = { id: Scalars['ID']; input?: Maybe; }; /** The schema's entry point for all mutation operations. */ export type MutationShippingPackageDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationShippingPackageMakeDefaultArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationShippingPackageUpdateArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationShopLocaleDisableArgs = { locale: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationShopLocaleEnableArgs = { locale: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationShopLocaleUpdateArgs = { locale: Scalars['String']; shopLocale: ShopLocaleInput; }; /** The schema's entry point for all mutation operations. */ export type MutationShopPolicyUpdateArgs = { shopPolicy: ShopPolicyInput; }; /** The schema's entry point for all mutation operations. */ export type MutationStagedUploadTargetGenerateArgs = { input: StagedUploadTargetGenerateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationStagedUploadTargetsGenerateArgs = { input: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationStagedUploadsCreateArgs = { input: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationStorefrontAccessTokenCreateArgs = { input: StorefrontAccessTokenInput; }; /** The schema's entry point for all mutation operations. */ export type MutationStorefrontAccessTokenDeleteArgs = { input: StorefrontAccessTokenDeleteInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionBillingAttemptCreateArgs = { subscriptionContractId: Scalars['ID']; subscriptionBillingAttemptInput: SubscriptionBillingAttemptInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionContractCreateArgs = { input: SubscriptionContractCreateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionContractSetNextBillingDateArgs = { contractId: Scalars['ID']; date: Scalars['DateTime']; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionContractUpdateArgs = { contractId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftCommitArgs = { draftId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftDiscountAddArgs = { draftId: Scalars['ID']; input: SubscriptionManualDiscountInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftDiscountCodeApplyArgs = { draftId: Scalars['ID']; redeemCode: Scalars['String']; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftDiscountRemoveArgs = { draftId: Scalars['ID']; discountId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftDiscountUpdateArgs = { draftId: Scalars['ID']; discountId: Scalars['ID']; input: SubscriptionManualDiscountInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftFreeShippingDiscountAddArgs = { draftId: Scalars['ID']; input: SubscriptionFreeShippingDiscountInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftFreeShippingDiscountUpdateArgs = { draftId: Scalars['ID']; discountId: Scalars['ID']; input: SubscriptionFreeShippingDiscountInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftLineAddArgs = { draftId: Scalars['ID']; input: SubscriptionLineInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftLineRemoveArgs = { draftId: Scalars['ID']; lineId: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftLineUpdateArgs = { draftId: Scalars['ID']; lineId: Scalars['ID']; input: SubscriptionLineUpdateInput; }; /** The schema's entry point for all mutation operations. */ export type MutationSubscriptionDraftUpdateArgs = { draftId: Scalars['ID']; input: SubscriptionDraftInput; }; /** The schema's entry point for all mutation operations. */ export type MutationTagsAddArgs = { id: Scalars['ID']; tags: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationTagsRemoveArgs = { id: Scalars['ID']; tags: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationTranslationsRegisterArgs = { resourceId: Scalars['ID']; translations: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationTranslationsRemoveArgs = { resourceId: Scalars['ID']; translationKeys: Array; locales: Array; }; /** The schema's entry point for all mutation operations. */ export type MutationWebhookSubscriptionCreateArgs = { topic: WebhookSubscriptionTopic; webhookSubscription: WebhookSubscriptionInput; }; /** The schema's entry point for all mutation operations. */ export type MutationWebhookSubscriptionDeleteArgs = { id: Scalars['ID']; }; /** The schema's entry point for all mutation operations. */ export type MutationWebhookSubscriptionUpdateArgs = { id: Scalars['ID']; webhookSubscription: WebhookSubscriptionInput; }; /** A signed upload parameter for uploading an asset to Shopify. */ export type MutationsStagedUploadTargetGenerateUploadParameter = { __typename?: 'MutationsStagedUploadTargetGenerateUploadParameter'; /** The upload parameter name. */ name: Scalars['String']; /** The upload parameter value. */ value: Scalars['String']; }; /** * A default cursor that you can use in queries to paginate your results. Each edge in a connection can * return a cursor, which is a reference to the edge's position in the connection. You can use an edge's cursor as * the starting point to retrieve the nodes before or after it in a connection. * * To learn more about using cursor-based pagination, refer to * [Paginating results with GraphQL](https://shopify.dev/concepts/graphql/pagination). */ export type Navigable = { /** A default cursor that returns the single next record, sorted ascending by ID. */ defaultCursor: Scalars['String']; }; /** A navigation item, holding basic link attributes. */ export type NavigationItem = { __typename?: 'NavigationItem'; /** The unique identifier of the navigation item. */ id: Scalars['String']; /** The name of the navigation item. */ title: Scalars['String']; /** The URL of the page that the navigation item links to. */ url: Scalars['URL']; }; /** An object with an ID to support global identification. */ export type Node = { /** Globally unique identifier. */ id: Scalars['ID']; }; /** * Represents an article in an OnlineStoreBlog object. Articles appear in reverse chronological order, with the * most recent entry at the top of the blog's page. A blog can contain any number of articles. * Currently, you can only use `OnlineStoreArticle` to pass an article `id` to the `tagsAdd` mutation. For * more information, refer to the [tagsAdd](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/tagsadd) mutation. */ export type OnlineStoreArticle = Node & Navigable & HasPublishedTranslations & { __typename?: 'OnlineStoreArticle'; /** A default cursor that returns the single next record, sorted ascending by ID. */ defaultCursor: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The translations associated with the resource. */ translations: Array; }; /** * Represents an article in an OnlineStoreBlog object. Articles appear in reverse chronological order, with the * most recent entry at the top of the blog's page. A blog can contain any number of articles. * Currently, you can only use `OnlineStoreArticle` to pass an article `id` to the `tagsAdd` mutation. For * more information, refer to the [tagsAdd](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/tagsadd) mutation. */ export type OnlineStoreArticleTranslationsArgs = { locale: Scalars['String']; }; /** * Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant * to be used as a type of magazine or newsletter for the shop, with content that changes over time. */ export type OnlineStoreBlog = Node & HasPublishedTranslations & { __typename?: 'OnlineStoreBlog'; /** Globally unique identifier. */ id: Scalars['ID']; /** The translations associated with the resource. */ translations: Array; }; /** * Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant * to be used as a type of magazine or newsletter for the shop, with content that changes over time. */ export type OnlineStoreBlogTranslationsArgs = { locale: Scalars['String']; }; /** A custom page on the Online Store. */ export type OnlineStorePage = Node & Navigable & HasPublishedTranslations & { __typename?: 'OnlineStorePage'; /** A default cursor that returns the single next record, sorted ascending by ID. */ defaultCursor: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The translations associated with the resource. */ translations: Array; }; /** A custom page on the Online Store. */ export type OnlineStorePageTranslationsArgs = { locale: Scalars['String']; }; /** Online Store preview URL of the object. */ export type OnlineStorePreviewable = { /** The online store preview URL. */ onlineStorePreviewUrl?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type Order = Node & CommentEventSubject & HasMetafields & LegacyInteroperability & HasEvents & HasLocalizationExtensions & { __typename?: 'Order'; /** * Generated messages that appear at the top of an order page in the Shopify admin. * For example, _this is a test order_. */ alerts: Array; /** * Mailing address provided by the customer. * Not all orders have mailing addresses. */ billingAddress?: Maybe; /** Whether the billing address matches the shipping address. */ billingAddressMatchesShippingAddress: Scalars['Boolean']; /** Whether the order can be manually marked as paid. */ canMarkAsPaid: Scalars['Boolean']; /** Whether notifications can be sent to the customer or not. */ canNotifyCustomer: Scalars['Boolean']; /** * Reason the order was canceled. * Returns null if the order wasn't canceled. */ cancelReason?: Maybe; /** * Date and time when the order was canceled. * Returns null if the order wasn't canceled. */ cancelledAt?: Maybe; /** * Whether payment for the order can be captured. * Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired. */ capturable: Scalars['Boolean']; /** * Amount of the order-level discount (does not contain any line item discounts). * @deprecated Use `cartDiscountAmountSet` instead */ cartDiscountAmount?: Maybe; /** Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies. */ cartDiscountAmountSet?: Maybe; /** * Channel that created the order. * @deprecated Use `publication` instead */ channel?: Maybe; /** The ip address of the client that is associated with this order. */ clientIp?: Maybe; /** Whether the order is closed. */ closed: Scalars['Boolean']; /** * Date and time when the order closed. * If the order is not closed, then this field is null. */ closedAt?: Maybe; /** Whether inventory has been reserved for the order. */ confirmed: Scalars['Boolean']; /** Date and time when the order was created in Shopify. */ createdAt: Scalars['DateTime']; /** * The currency of the store at the time of the order. * If payment hasn't occurred, then this field is null. */ currencyCode: CurrencyCode; /** The amount of the order-level discount minus the amounts for line items that have been returned. This doesn't include line item discounts. */ currentCartDiscountAmountSet: MoneyBag; /** The sum of the quantities for the line items that contribute to the order's subtotal. */ currentSubtotalLineItemsQuantity: Scalars['Int']; /** The subtotal of line items and their discounts minus the line items that have been returned. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order. */ currentSubtotalPriceSet: MoneyBag; /** The taxes charged for the order minus the taxes for line items that have been returned. */ currentTaxLines: Array; /** The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned. */ currentTotalDiscountsSet: MoneyBag; /** The total amount of duties for the order. If duties aren't applicable, then this value is `null`. */ currentTotalDutiesSet?: Maybe; /** The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned. */ currentTotalPriceSet: MoneyBag; /** The total of all taxes applied to the order minus the taxes for line items that have been returned. */ currentTotalTaxSet: MoneyBag; /** The total weight (grams) of the order minus the weights for line items that have been returned. */ currentTotalWeight: Scalars['UnsignedInt64']; /** * Custom information added to the order by your customer * (Also referred to as note attributes). */ customAttributes: Array; /** * Unique identifier of the customer who placed the order. * Not all orders have customers associated with them. */ customer?: Maybe; /** Whether the customer agreed to receive marketing materials. */ customerAcceptsMarketing: Scalars['Boolean']; /** * Description of the customer's experience with the store leading up to the order. * @deprecated Use `customerJourneySummary` instead */ customerJourney?: Maybe; /** * Description of the customer's experience with the store leading up to the order. * Loaded asynchronously, consumers should poll until the 'ready' field resolves to true. */ customerJourneySummary?: Maybe; /** * A two-letter or three-letter language code, optionally followed by a region modifier. * Example values could be 'en', 'en-CA', 'en-PIRATE'. */ customerLocale?: Maybe; /** Discounts that have been applied on the order. */ discountApplications: DiscountApplicationConnection; /** Discount code provided by the customer. */ discountCode?: Maybe; /** Primary address of the customer, which is shown on the order. */ displayAddress?: Maybe; /** * Financial status of the order that can be shown to the merchant. * This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes. */ displayFinancialStatus?: Maybe; /** * Fulfillment status for the order that can be shown to the merchant. * This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes. */ displayFulfillmentStatus: OrderDisplayFulfillmentStatus; /** Summary of each dispute associated with the order. Sorted in ascending (ASC) order by ID. */ disputes: Array; /** * List of possible fulfilments that can be made for the order (includes line items that can be partially fulfilled). * @deprecated Use `fulfillmentOrders` instead */ draftFulfillments: Array; /** Whether the order has had any edits applied or not. */ edited: Scalars['Boolean']; /** Email address provided by the customer. */ email?: Maybe; /** List of internal events associated with the order. */ events: EventConnection; /** * Whether there are items that can be fulfilled. * After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false. */ fulfillable: Scalars['Boolean']; /** List of fulfillment orders with pagination. */ fulfillmentOrders: FulfillmentOrderConnection; /** List of shipments for the order. */ fulfillments: Array; /** Whether the order has been paid in full. */ fullyPaid: Scalars['Boolean']; /** Whether the merchant added timeline comments to the order. */ hasTimelineComment: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** * First page of the online store that the customer visited before they submitted the order, for displaying to humans. * @deprecated Use `customerJourneySummary.lastVisit.landingPageHtml` instead */ landingPageDisplayText?: Maybe; /** * First page of the online store that the customer visited before they submitted the order. * @deprecated Use `customerJourneySummary.lastVisit.landingPage` instead */ landingPageUrl?: Maybe; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** List of the order's line items. */ lineItems: LineItemConnection; /** * List of the order's line items after any edits. Only available on Developer Preview. * @deprecated Use `lineItems` instead */ lineItemsMutable: LineItemMutableConnection; /** List of localization extensions for the resource. */ localizationExtensions: LocalizationExtensionConnection; /** * If the order was processed using Shopify POS, then this is its location as provided by the merchant. * @deprecated Use `physicalLocation` instead */ location?: Maybe; /** Whether the order can be edited or not. */ merchantEditable: Scalars['Boolean']; /** A list of reasons of why the order cannot be edited. */ merchantEditableErrors: Array; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** * Unique identifier for the order that appears on the order. * For example, _#1000_ or _Store1001. * This value is not unique across multiple stores. */ name: Scalars['String']; /** * Net payment for the order, based on the total amount received - total amount refunded. * @deprecated Use `netPaymentSet` instead */ netPayment: Scalars['Money']; /** Net payment for the order, based on the total amount received - total amount refunded in shop and presentment currencies. */ netPaymentSet: MoneyBag; /** * Line items that can't be fulfilled. * For example, because some or all of the items have been refunded, or the item is not one which can be fulfilled, such as a tip. * These line items would be 'lost' if you only considered the line items in draft fulfillments or fulfillments. */ nonFulfillableLineItems: LineItemConnection; /** Contents of the note associated with the order. */ note?: Maybe; /** The total amount of duties prior to any applied edits for the order. If duties aren't applicable, then this value is `null`. */ originalTotalDutiesSet?: Maybe; /** Total price of the order prior to any applied edits in shop and presentment currencies. */ originalTotalPriceSet: MoneyBag; /** The payment collection details for an order requiring additional payment. */ paymentCollectionDetails: OrderPaymentCollectionDetails; /** * List of all payment gateways used for the order. * For example, _authorize_net_ and _Cash on Delivery (COD)_. */ paymentGatewayNames: Array; /** Phone number provided by the customer. */ phone?: Maybe; /** If the order was processed using Shopify POS, then this is its location as provided by the merchant. */ physicalLocation?: Maybe; /** The payment currency of the customer for this order. */ presentmentCurrencyCode: CurrencyCode; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** * Date and time when the order was processed. * When orders are imported from an app, this date and time may not match the date and time when the order was created. */ processedAt: Scalars['DateTime']; /** Publication that created the order. */ publication?: Maybe; /** * Marketing referral code from the link that the customer clicked to visit your store. * Supports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. * @deprecated Use `customerJourneySummary.lastVisit.referralCode` instead */ referralCode?: Maybe; /** * Website that sent the customer to your online store. * @deprecated Use `customerJourneySummary.lastVisit.referralInfoHtml` instead */ referrerDisplayText?: Maybe; /** * Webpage where the customer clicked a link that sent them to your online store. * For example, _Google_ or _randomblog.com/page1_. * @deprecated Use `customerJourneySummary.lastVisit.referrerUrl` instead */ referrerUrl?: Maybe; /** The difference between suggested and actual refund amounts. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor. */ refundDiscrepancySet: MoneyBag; /** Whether the order can be refunded. */ refundable: Scalars['Boolean']; /** List of refunds that have been applied to the order. */ refunds: Array; /** Whether any line item in the order requires physical shipping. */ requiresShipping: Scalars['Boolean']; /** Whether the order can be restocked. */ restockable: Scalars['Boolean']; /** Fraud risk level of the order. */ riskLevel: OrderRiskLevel; /** The order risks associated with this order. */ risks: Array; /** Mailing address for shipping provided by the customer. */ shippingAddress?: Maybe; /** Line item that contains the shipping costs. */ shippingLine?: Maybe; /** List of line items that contains the shipping costs. */ shippingLines: ShippingLineConnection; /** The sum of the quantities for the line items that contribute to the order's subtotal. */ subtotalLineItemsQuantity: Scalars['Int']; /** * Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts). * @deprecated Use `subtotalPriceSet` instead */ subtotalPrice?: Maybe; /** Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop and presentment currencies. */ subtotalPriceSet?: Maybe; /** The details of the suggested refund. This response can be used to submit a RefundCreate mutation. */ suggestedRefund?: Maybe; /** * A comma separated list of tags associated with the order. Updating `tags` overwrites * any existing tags that were previously added to the order. To add new tags without overwriting * existing tags, use the [tagsAdd](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/tagsadd) * mutation. */ tags: Array; /** Taxes charged for the line item. */ taxLines: Array; /** Whether taxes are included in the subtotal price of the order. */ taxesIncluded: Scalars['Boolean']; /** * Whether the order is a test. * Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. */ test: Scalars['Boolean']; /** * Amount authorized for the order, that is uncaptured or undercaptured. * @deprecated Use `totalCapturableSet` instead */ totalCapturable: Scalars['Money']; /** Amount authorized for the order, that is uncaptured or undercaptured in shop and presentment currencies. */ totalCapturableSet: MoneyBag; /** * Total amount discounted from the order (includes order-level and line item discounts). * @deprecated Use `totalDiscountsSet` instead */ totalDiscounts?: Maybe; /** Total amount discounted from the order (includes order-level and line item discounts) in shop and presentment currencies. */ totalDiscountsSet?: Maybe; /** Total amount of money not yet authorized for the order. */ totalOutstandingSet: MoneyBag; /** * Total amount of the order (includes taxes and discounts). * @deprecated Use `totalPriceSet` instead */ totalPrice: Scalars['Money']; /** Total amount of the order (includes taxes and discounts) in shop and presentment currencies. */ totalPriceSet: MoneyBag; /** * Total amount received by the customer for the order. * @deprecated Use `totalReceivedSet` instead */ totalReceived: Scalars['Money']; /** Total amount received by the customer for the order in shop and presentment currencies. */ totalReceivedSet: MoneyBag; /** * Total amount refunded for the order. * @deprecated Use `totalRefundedSet` instead */ totalRefunded: Scalars['Money']; /** Total amount refunded for the order in shop and presentment currencies. */ totalRefundedSet: MoneyBag; /** Total amount refunded for shipping in shop and presentment currencies. */ totalRefundedShippingSet: MoneyBag; /** * Total amount charged for shipping the order. * @deprecated Use `totalShippingPriceSet` instead */ totalShippingPrice: Scalars['Money']; /** Total amount charged for shipping the order in shop and presentment currencies. */ totalShippingPriceSet: MoneyBag; /** * Total of all taxes applied to the order. * @deprecated Use `totalTaxSet` instead */ totalTax?: Maybe; /** Total of all taxes applied to the order in shop and presentment currencies. */ totalTaxSet?: Maybe; /** * Total tip amount received for the order. * @deprecated Use `totalTipReceivedSet` instead */ totalTipReceived: MoneyV2; /** Total tip received for the order in shop and presentment currencies. */ totalTipReceivedSet: MoneyBag; /** Total weight (grams) of the order. */ totalWeight?: Maybe; /** List of all transactions associated with the order. */ transactions: Array; /** * Whether no payments have been made for the order. * If no payments have been made for the order, then this returns true. */ unpaid: Scalars['Boolean']; /** Date and time when the order was last modified. */ updatedAt: Scalars['DateTime']; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderDiscountApplicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderFulfillmentOrdersArgs = { displayable?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderFulfillmentsArgs = { first?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderLineItemsMutableArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderLocalizationExtensionsArgs = { countryCodes?: Maybe>; purposes?: Maybe>; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderNonFulfillableLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderRefundsArgs = { first?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderRisksArgs = { first?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderShippingLinesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderSuggestedRefundArgs = { shippingAmount?: Maybe; refundShipping?: Maybe; refundLineItems?: Maybe>; refundDuties?: Maybe>; suggestFullRefund?: Maybe; }; /** An order represents an agreement to do business between a customer and a merchant. */ export type OrderTransactionsArgs = { first?: Maybe; capturable?: Maybe; manuallyResolvable?: Maybe; }; /** Represents the reason that the order is being canceled. Valid values are: customer, fraud, inventory, declined, other. */ export enum OrderCancelReason { /** The customer wanted to cancel the order. */ Customer = 'CUSTOMER', /** The order was fraudulent. */ Fraud = 'FRAUD', /** There was insufficient inventory. */ Inventory = 'INVENTORY', /** Payment was declined. */ Declined = 'DECLINED', /** Some other reason not listed. */ Other = 'OTHER' } /** Specifies the authorized transaction to capture and the total amount to capture from it. */ export type OrderCaptureInput = { /** The ID of the order to capture. */ id: Scalars['ID']; /** The ID of the authorized transaction to capture. */ parentTransactionId: Scalars['ID']; /** The amount to capture. */ amount: Scalars['Money']; /** The currency (in ISO format) that is used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ. */ currency?: Maybe; }; /** Return type for `orderCapture` mutation. */ export type OrderCapturePayload = { __typename?: 'OrderCapturePayload'; /** The transaction of the capture. */ transaction?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies an open order to close. */ export type OrderCloseInput = { /** The ID of the order to close. */ id: Scalars['ID']; }; /** Return type for `orderClose` mutation. */ export type OrderClosePayload = { __typename?: 'OrderClosePayload'; /** The closed order. */ order?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple Orders. */ export type OrderConnection = { __typename?: 'OrderConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Represents the order's current financial status. */ export enum OrderDisplayFinancialStatus { /** Displayed as **Pending**. */ Pending = 'PENDING', /** Displayed as **Authorized**. */ Authorized = 'AUTHORIZED', /** Displayed as **Partially paid**. */ PartiallyPaid = 'PARTIALLY_PAID', /** Displayed as **Partially refunded**. */ PartiallyRefunded = 'PARTIALLY_REFUNDED', /** Displayed as **Voided**. */ Voided = 'VOIDED', /** Displayed as **Paid**. */ Paid = 'PAID', /** Displayed as **Refunded**. */ Refunded = 'REFUNDED', /** Displayed as **Expired**. */ Expired = 'EXPIRED' } /** Represents the order's current fulfillment status. Valid values are: unfulfilled, partial, fulfilled, restocked. */ export enum OrderDisplayFulfillmentStatus { /** Displayed as **Unfulfilled**. */ Unfulfilled = 'UNFULFILLED', /** Displayed as **Partially fulfilled**. */ PartiallyFulfilled = 'PARTIALLY_FULFILLED', /** Displayed as **Fulfilled**. */ Fulfilled = 'FULFILLED', /** Displayed as **Restocked**. */ Restocked = 'RESTOCKED', /** Displayed as **Pending fulfillment**. */ PendingFulfillment = 'PENDING_FULFILLMENT', /** Displayed as **Open**. */ Open = 'OPEN', /** Displayed as **In progress**. */ InProgress = 'IN_PROGRESS', /** Displayed as **Scheduled**. */ Scheduled = 'SCHEDULED' } /** A summary of the important details for a dispute on an order. */ export type OrderDisputeSummary = Node & { __typename?: 'OrderDisputeSummary'; /** Globally unique identifier. */ id: Scalars['ID']; /** The type that the dispute was initiated as. */ initiatedAs: DisputeType; /** The current status of the dispute. */ status: DisputeStatus; }; /** An auto-generated type which holds one Order and a cursor during pagination. */ export type OrderEdge = { __typename?: 'OrderEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of OrderEdge. */ node: Order; }; /** Return type for `orderEditAddCustomItem` mutation. */ export type OrderEditAddCustomItemPayload = { __typename?: 'OrderEditAddCustomItemPayload'; /** The added line item. */ calculatedLineItem?: Maybe; /** An order with the edits calculated. */ calculatedOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `orderEditAddLineItemDiscount` mutation. */ export type OrderEditAddLineItemDiscountPayload = { __typename?: 'OrderEditAddLineItemDiscountPayload'; /** The staged change produced by this mutation. */ addedDiscountStagedChange?: Maybe; /** The line item with the discount applied. */ calculatedLineItem?: Maybe; /** An order with the edits calculated. */ calculatedOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `orderEditAddVariant` mutation. */ export type OrderEditAddVariantPayload = { __typename?: 'OrderEditAddVariantPayload'; /** The added line item. */ calculatedLineItem?: Maybe; /** An order with the edits calculated. */ calculatedOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The input fields used to add a discount during an order edit. */ export type OrderEditAppliedDiscountInput = { /** The description of the discount. */ description?: Maybe; /** The value of the discount as a fixed amount. */ fixedValue?: Maybe; /** The value of the discount as a percentage. */ percentValue?: Maybe; }; /** Return type for `orderEditBegin` mutation. */ export type OrderEditBeginPayload = { __typename?: 'OrderEditBeginPayload'; /** The order that will be edited. */ calculatedOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `orderEditCommit` mutation. */ export type OrderEditCommitPayload = { __typename?: 'OrderEditCommitPayload'; /** The order with changes applied. */ order?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `orderEditRemoveLineItemDiscount` mutation. */ export type OrderEditRemoveLineItemDiscountPayload = { __typename?: 'OrderEditRemoveLineItemDiscountPayload'; /** The line item with the discount removed. */ calculatedLineItem?: Maybe; /** An order with the edits calculated. */ calculatedOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `orderEditSetQuantity` mutation. */ export type OrderEditSetQuantityPayload = { __typename?: 'OrderEditSetQuantityPayload'; /** The line item with changes calculated. */ calculatedLineItem?: Maybe; /** An order with the edits calculated. */ calculatedOrder?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the information to be updated on the requested order. */ export type OrderInput = { /** The email address associated with the order. */ email?: Maybe; /** The ID of the order to update. */ id: Scalars['ID']; /** The order note. */ note?: Maybe; /** A comma separated list of tags that have been added to the order. */ tags?: Maybe>; /** The shipping address associated with the order. */ shippingAddress?: Maybe; /** Custom information to add to the order, represented as a key value pair. Also referred to as note attributes. */ customAttributes?: Maybe>; /** The metafields to associate with this order. */ metafields?: Maybe>; /** The localization extensions attached to the order. For example, Tax IDs. */ localizationExtensions?: Maybe>; }; /** Specifies the order to mark as paid. */ export type OrderMarkAsPaidInput = { /** The ID of the order to mark as paid. */ id: Scalars['ID']; }; /** Return type for `orderMarkAsPaid` mutation. */ export type OrderMarkAsPaidPayload = { __typename?: 'OrderMarkAsPaidPayload'; /** The order marked as paid. */ order?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies a closed order to open. */ export type OrderOpenInput = { /** The ID of the order to open. */ id: Scalars['ID']; }; /** Return type for `orderOpen` mutation. */ export type OrderOpenPayload = { __typename?: 'OrderOpenPayload'; /** The opened order. */ order?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The payment collection details for an order requiring additional payment. */ export type OrderPaymentCollectionDetails = { __typename?: 'OrderPaymentCollectionDetails'; /** URL allowing additional payments to be collected on the order. */ additionalPaymentCollectionUrl?: Maybe; }; /** Represents a fraud check on an order. */ export type OrderRisk = { __typename?: 'OrderRisk'; /** Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order. */ display: Scalars['Boolean']; /** * The likelihood that an order is fraudulent, based on this order risk. * * The level can be set by Shopify risk analysis or by an app. */ level?: Maybe; /** The risk message that's shown to the merchant in the Shopify admin. */ message?: Maybe; }; /** The likelihood that an order is fraudulent. */ export enum OrderRiskLevel { /** There is a low level of risk that this order is fraudulent. */ Low = 'LOW', /** There is a medium level of risk that this order is fraudulent. */ Medium = 'MEDIUM', /** There is a high level of risk that this order is fraudulent. */ High = 'HIGH' } /** The set of valid sort keys for the Order query. */ export enum OrderSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `customer_name` value. */ CustomerName = 'CUSTOMER_NAME', /** Sort by the `financial_status` value. */ FinancialStatus = 'FINANCIAL_STATUS', /** Sort by the `fulfillment_status` value. */ FulfillmentStatus = 'FULFILLMENT_STATUS', /** Sort by the `order_number` value. */ OrderNumber = 'ORDER_NUMBER', /** Sort by the `processed_at` value. */ ProcessedAt = 'PROCESSED_AT', /** Sort by the `total_price` value. */ TotalPrice = 'TOTAL_PRICE', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** A change that has been applied to an order. */ export type OrderStagedChange = OrderStagedChangeAddCustomItem | OrderStagedChangeAddLineItemDiscount | OrderStagedChangeAddShippingLine | OrderStagedChangeAddVariant | OrderStagedChangeDecrementItem | OrderStagedChangeIncrementItem; /** A newly created custom item. */ export type OrderStagedChangeAddCustomItem = { __typename?: 'OrderStagedChangeAddCustomItem'; /** The price of an individual item without any discounts applied. */ originalUnitPrice: MoneyV2; /** The number of items. */ quantity: Scalars['Int']; /** The title of the item. */ title: Scalars['String']; }; /** A discount application added as part of an order edit. */ export type OrderStagedChangeAddLineItemDiscount = { __typename?: 'OrderStagedChangeAddLineItemDiscount'; /** The description of the discount. */ description: Scalars['String']; /** A globally unique identifier. */ id: Scalars['ID']; /** The amount of the discount. */ value: PricingValue; }; /** A new shipping line added as part of an order edit. */ export type OrderStagedChangeAddShippingLine = { __typename?: 'OrderStagedChangeAddShippingLine'; /** Shipping line phone number. */ phone?: Maybe; /** The presentment title of the shipping line. */ presentmentTitle?: Maybe; /** Price of shipping line. */ price: MoneyV2; /** The title of the shipping line. */ title?: Maybe; }; /** A new item created from an existing product variant. */ export type OrderStagedChangeAddVariant = { __typename?: 'OrderStagedChangeAddVariant'; /** The number of items. */ quantity: Scalars['Int']; /** The product variant of the added item. */ variant: ProductVariant; }; /** An auto-generated type for paginating through multiple OrderStagedChanges. */ export type OrderStagedChangeConnection = { __typename?: 'OrderStagedChangeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An removal of items from an existing line item on the order. */ export type OrderStagedChangeDecrementItem = { __typename?: 'OrderStagedChangeDecrementItem'; /** The number of items removed. */ delta: Scalars['Int']; /** The original line item. */ lineItem: LineItem; /** The intention to restock the removed items. */ restock: Scalars['Boolean']; }; /** An auto-generated type which holds one OrderStagedChange and a cursor during pagination. */ export type OrderStagedChangeEdge = { __typename?: 'OrderStagedChangeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of OrderStagedChangeEdge. */ node: OrderStagedChange; }; /** An addition of items to an existing line item on the order. */ export type OrderStagedChangeIncrementItem = { __typename?: 'OrderStagedChangeIncrementItem'; /** The number of items added. */ delta: Scalars['Int']; /** The original line item. */ lineItem: LineItem; }; /** A transaction represents an exchange of money as part of an order. */ export type OrderTransaction = Node & { __typename?: 'OrderTransaction'; /** The masked account number associated with the payment method. */ accountNumber?: Maybe; /** * The amount of money. * @deprecated Use `amountSet` instead */ amount: Scalars['Money']; /** The amount and currency of the transaction in shop and presentment currencies. */ amountSet: MoneyBag; /** * The amount and currency of the transaction. * @deprecated Use `amountSet` instead */ amountV2: MoneyV2; /** Authorization code associated with the transaction. */ authorizationCode?: Maybe; /** The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. */ authorizationExpiresAt?: Maybe; /** Date and time when the transaction was created. */ createdAt: Scalars['DateTime']; /** A standardized error code, independent of the payment provider. */ errorCode?: Maybe; /** The transaction fees charged on the order transaction. */ fees: Array; /** The human-readable payment gateway name used to process the transaction. */ formattedGateway?: Maybe; /** The payment gateway used to process the transaction. */ gateway?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The kind of transaction. */ kind: OrderTransactionKind; /** Whether the transaction can be manually captured. */ manuallyCapturable: Scalars['Boolean']; /** * Specifies the available amount to refund on the gateway. Only available within SuggestedRefund. * @deprecated Use `maximumRefundableV2` instead */ maximumRefundable?: Maybe; /** * Specifies the available amount with currency to refund on the gateway. * Only available within SuggestedRefund. */ maximumRefundableV2?: Maybe; /** The associated order. */ order?: Maybe; /** The associated parent transaction, for example the authorization of a capture. */ parentTransaction?: Maybe; /** Specifies the payment icon to display for this transaction. */ paymentIcon?: Maybe; /** * Specifies the credit card company used to pay for this transaction. * @deprecated Use `paymentIcon` instead */ paymentMethod?: Maybe; /** Date and time when the transaction was processed. */ processedAt?: Maybe; /** * A transaction receipt attached to the transaction by the gateway. * The value of this field depends on which gateway processed the transaction. * @deprecated Use `receiptJson` instead */ receipt?: Maybe; /** The settlement currency. */ settlementCurrency?: Maybe; /** The rate used when converting the transaction amount to settlement currency. */ settlementCurrencyRate?: Maybe; /** Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan. */ shopifyPaymentsSet?: Maybe; /** The status of this transaction. */ status: OrderTransactionStatus; /** Whether the transaction is a test transaction. */ test: Scalars['Boolean']; /** * Specifies the available amount to capture on the gateway. * Only available when an amount is capturable or manually mark as paid. * @deprecated Use `totalUnsettledSet` instead */ totalUnsettled?: Maybe; /** * Specifies the available amount with currency to capture on the gateway in shop and presentment currencies. * Only available when an amount is capturable or manually mark as paid. */ totalUnsettledSet?: Maybe; /** * Specifies the available amount with currency to capture on the gateway. * Only available when an amount is capturable or manually mark as paid. * @deprecated Use `totalUnsettledSet` instead */ totalUnsettledV2?: Maybe; }; /** A transaction represents an exchange of money as part of an order. */ export type OrderTransactionPaymentIconArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** An auto-generated type for paginating through multiple OrderTransactions. */ export type OrderTransactionConnection = { __typename?: 'OrderTransactionConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one OrderTransaction and a cursor during pagination. */ export type OrderTransactionEdge = { __typename?: 'OrderTransactionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of OrderTransactionEdge. */ node: OrderTransaction; }; /** A standardized error code, independent of the payment provider. */ export enum OrderTransactionErrorCode { /** The card number is incorrect. */ IncorrectNumber = 'INCORRECT_NUMBER', /** The format of the card number is incorrect. */ InvalidNumber = 'INVALID_NUMBER', /** The format of the expiry date is incorrect. */ InvalidExpiryDate = 'INVALID_EXPIRY_DATE', /** The format of the CVC is incorrect. */ InvalidCvc = 'INVALID_CVC', /** The card is expired. */ ExpiredCard = 'EXPIRED_CARD', /** The CVC does not match the card number. */ IncorrectCvc = 'INCORRECT_CVC', /** The ZIP or postal code does not match the card number. */ IncorrectZip = 'INCORRECT_ZIP', /** The address does not match the card number. */ IncorrectAddress = 'INCORRECT_ADDRESS', /** The entered PIN is incorrect. */ IncorrectPin = 'INCORRECT_PIN', /** The card was declined. */ CardDeclined = 'CARD_DECLINED', /** There was an error while processing the payment. */ ProcessingError = 'PROCESSING_ERROR', /** Call the card issuer. */ CallIssuer = 'CALL_ISSUER', /** The card has been reported as lost or stolen, and the card issuer has requested that the merchant keep the card and call the number on the back. */ PickUpCard = 'PICK_UP_CARD', /** There is an error in the gateway or merchant configuration. */ ConfigError = 'CONFIG_ERROR', /** A real card was used but the gateway was in test mode. */ TestModeLiveCard = 'TEST_MODE_LIVE_CARD', /** The gateway or merchant configuration doesn't support a feature, such as network tokenization. */ UnsupportedFeature = 'UNSUPPORTED_FEATURE', /** There was an unknown error with processing the payment. */ GenericError = 'GENERIC_ERROR', /** The payment method is not available in the customer's country. */ InvalidCountry = 'INVALID_COUNTRY', /** The amount is either too high or too low for the provider. */ InvalidAmount = 'INVALID_AMOUNT', /** The payment method is momentarily unavailable. */ PaymentMethodUnavailable = 'PAYMENT_METHOD_UNAVAILABLE', /** The payment method was invalid. */ AmazonPaymentsInvalidPaymentMethod = 'AMAZON_PAYMENTS_INVALID_PAYMENT_METHOD', /** The maximum amount has been captured. */ AmazonPaymentsMaxAmountCharged = 'AMAZON_PAYMENTS_MAX_AMOUNT_CHARGED', /** The maximum amount has been refunded. */ AmazonPaymentsMaxAmountRefunded = 'AMAZON_PAYMENTS_MAX_AMOUNT_REFUNDED', /** The maximum of 10 authorizations has been captured for an order. */ AmazonPaymentsMaxAuthorizationsCaptured = 'AMAZON_PAYMENTS_MAX_AUTHORIZATIONS_CAPTURED', /** The maximum of 10 refunds has been processed for an order. */ AmazonPaymentsMaxRefundsProcessed = 'AMAZON_PAYMENTS_MAX_REFUNDS_PROCESSED', /** The order was canceled, which canceled all open authorizations. */ AmazonPaymentsOrderReferenceCanceled = 'AMAZON_PAYMENTS_ORDER_REFERENCE_CANCELED', /** The order was not confirmed within three hours. */ AmazonPaymentsStale = 'AMAZON_PAYMENTS_STALE' } /** Specifies the information needed to create an order transaction. */ export type OrderTransactionInput = { /** The amount of money for this transaction. */ amount: Scalars['Money']; /** The payment gateway to use for this transaction. */ gateway: Scalars['String']; /** The kind of transaction. */ kind: OrderTransactionKind; /** The ID of the order associated with the transaction. */ orderId: Scalars['ID']; /** The ID of the optional parent transaction, for example the authorization of a capture. */ parentId?: Maybe; }; /** The different kinds of order transactions. */ export enum OrderTransactionKind { /** An authorization and capture performed together in a single step. */ Sale = 'SALE', /** A transfer of the money that was reserved during the authorization stage. */ Capture = 'CAPTURE', /** * An amount reserved against the cardholder's funding source. * Money does not change hands until the authorization is captured. */ Authorization = 'AUTHORIZATION', /** A cancellation of a pending authorization or capture. */ Void = 'VOID', /** * A partial or full return of captured funds to the cardholder. * A refund can happen only after a capture is processed. */ Refund = 'REFUND', /** Money returned to the customer when they have paid too much. */ Change = 'CHANGE', /** An authorization for a payment taken with an EMV credit card reader. */ EmvAuthorization = 'EMV_AUTHORIZATION', /** A suggested refund transaction that can be used to create a refund. */ SuggestedRefund = 'SUGGESTED_REFUND' } /** Transaction status' describe the status of a transaction. */ export enum OrderTransactionStatus { /** The transaction succeeded. */ Success = 'SUCCESS', /** The transaction failed. */ Failure = 'FAILURE', /** The transaction is pending. */ Pending = 'PENDING', /** There was an error while processing the transaction. */ Error = 'ERROR', /** Awaiting a response. */ AwaitingResponse = 'AWAITING_RESPONSE', /** The transaction status is unknown. */ Unknown = 'UNKNOWN' } /** Return type for `orderUpdate` mutation. */ export type OrderUpdatePayload = { __typename?: 'OrderUpdatePayload'; /** The updated order. */ order?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Information about pagination in a connection. */ export type PageInfo = { __typename?: 'PageInfo'; /** Indicates if there are more pages to fetch. */ hasNextPage: Scalars['Boolean']; /** Indicates if there are any pages prior to the current page. */ hasPreviousPage: Scalars['Boolean']; }; /** List of payment methods used in Shopify. */ export enum PaymentMethods { Visa = 'VISA', Mastercard = 'MASTERCARD', Discover = 'DISCOVER', AmericanExpress = 'AMERICAN_EXPRESS', DinersClub = 'DINERS_CLUB', Jcb = 'JCB', Dankort = 'DANKORT', Maestro = 'MAESTRO', Forbrugsforeningen = 'FORBRUGSFORENINGEN', Paypal = 'PAYPAL', Bogus = 'BOGUS', Bitcoin = 'BITCOIN', Litecoin = 'LITECOIN', Dogecoin = 'DOGECOIN' } /** Represents a payment session. */ export type PaymentSession = { __typename?: 'PaymentSession'; /** A globally unique identifier. */ id: Scalars['ID']; /** The next action expected by the partner. */ nextAction?: Maybe; /** The payment status. */ status: PaymentSessionStatus; }; /** The payload required to perform a redirect action. */ export type PaymentSessionActionsRedirect = { __typename?: 'PaymentSessionActionsRedirect'; /** The URL of the checkout that is used to redirect the customer. */ redirectUrl: Scalars['URL']; }; /** Represents the next action expected by the partner. */ export type PaymentSessionNextAction = { __typename?: 'PaymentSessionNextAction'; /** The action expected by the partner. */ action: PaymentSessionNextActionAction; /** The context required to perform an action. */ context: PaymentSessionNextActionContext; }; /** Partner payment actions. */ export enum PaymentSessionNextActionAction { /** Redirect the customer to the next checkout step. */ Redirect = 'REDIRECT' } /** The context required to perform an action. */ export type PaymentSessionNextActionContext = PaymentSessionActionsRedirect; /** Return type for `paymentSessionReject` mutation. */ export type PaymentSessionRejectPayload = { __typename?: 'PaymentSessionRejectPayload'; /** The updated payment session. */ paymentSession?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Reason of the payment status. */ export type PaymentSessionRejectionReasonInput = { /** The reason code. */ code: PaymentSessionStatusReasonRejectionCode; /** A custom, localized message for the merchant. */ merchantMessage?: Maybe; }; /** Return type for `paymentSessionResolve` mutation. */ export type PaymentSessionResolvePayload = { __typename?: 'PaymentSessionResolvePayload'; /** The updated payment session. */ paymentSession?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a payment status. */ export type PaymentSessionStatus = { __typename?: 'PaymentSessionStatus'; /** The payment status code. */ code: PaymentSessionStatusCode; /** The payment status reason (if applicable). */ reason?: Maybe; }; /** Payment status codes. */ export enum PaymentSessionStatusCode { /** Payment rejected. */ Rejected = 'REJECTED', /** Payment resolved. */ Resolved = 'RESOLVED' } /** Payment status reason. */ export type PaymentSessionStatusReason = { __typename?: 'PaymentSessionStatusReason'; /** The reason code. */ code: PaymentSessionStatusReasonRejectionCode; /** The custom, localized message for the merchant. */ merchantMessage?: Maybe; }; /** Payment rejection reason codes. */ export enum PaymentSessionStatusReasonRejectionCode { /** Rejected by risk control. */ Risky = 'RISKY', /** Payment processing failure. */ ProcessingError = 'PROCESSING_ERROR' } /** Settings related to payments. */ export type PaymentSettings = { __typename?: 'PaymentSettings'; /** List of the digital wallets which the shop supports. */ supportedDigitalWallets: Array; }; /** The production configuration of the payments app. */ export type PaymentsAppConfiguration = { __typename?: 'PaymentsAppConfiguration'; /** Handle used by the provider. */ externalHandle?: Maybe; /** The provider is ready to process merchant's payments. */ ready: Scalars['Boolean']; }; /** Return type for `paymentsAppConfigure` mutation. */ export type PaymentsAppConfigurePayload = { __typename?: 'PaymentsAppConfigurePayload'; /** The production configuration of the payments app. */ paymentsAppConfiguration?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Represents a price list, including information about related prices and eligibility rules. * You can use price lists to specify either fixed prices or adjusted relative prices that * override initial product variant prices. Price lists are applied to customers * using context rules, which determine price list eligibility. * * For more information on price lists, refer to * [*Support different pricing models using the price list API*](https://shopify.dev/tutorials/support-different-pricing-models-with-the-price-list-api#update-an-existing-price-list). */ export type PriceList = Node & { __typename?: 'PriceList'; /** A set of facts about the customer, used to determine price list eligibility. */ contextRule?: Maybe; /** The currency for fixed prices associated with this price list. */ currency: CurrencyCode; /** Globally unique identifier. */ id: Scalars['ID']; /** The unique name of the price list, used as a human-readable identifier. */ name: Scalars['String']; /** Relative adjustments to other prices. */ parent?: Maybe; /** A list of prices associated with the price list. */ prices: PriceListPriceConnection; }; /** * Represents a price list, including information about related prices and eligibility rules. * You can use price lists to specify either fixed prices or adjusted relative prices that * override initial product variant prices. Price lists are applied to customers * using context rules, which determine price list eligibility. * * For more information on price lists, refer to * [*Support different pricing models using the price list API*](https://shopify.dev/tutorials/support-different-pricing-models-with-the-price-list-api#update-an-existing-price-list). */ export type PriceListPricesArgs = { originType?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the type and value of price list adjustments. */ export type PriceListAdjustment = { __typename?: 'PriceListAdjustment'; /** The type of price adjustment, such as percentage increase or decrease. */ type: PriceListAdjustmentType; /** * The value of price adjustment, where positive numbers * reduce the prices and negative numbers increase them. */ value: Scalars['Float']; }; /** Provides the fields and values to use when updating a price list parent adjustment. */ export type PriceListAdjustmentInput = { /** * The value of the price adjustment, where positive numbers reduce * the prices and negative numbers increase them. */ value: Scalars['Float']; /** The type of price adjustment, such as percentage increase or decrease. */ type: PriceListAdjustmentType; }; /** Represents a percentage price adjustment type. */ export enum PriceListAdjustmentType { /** Percentage decrease type. Prices will have a lower value. */ PercentageDecrease = 'PERCENTAGE_DECREASE', /** Percentage increase type. Prices will have a higher value. */ PercentageIncrease = 'PERCENTAGE_INCREASE' } /** An auto-generated type for paginating through multiple PriceLists. */ export type PriceListConnection = { __typename?: 'PriceListConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Represents a set of facts about the customer used to determine price list eligibility. For example, you can specify the country code so that the price list only applies to customers visiting from a specific country. */ export type PriceListContext = { /** The code for the country that the price list applies to. */ country?: Maybe; }; /** Represents a set of facts about the customer used to determine price list eligibility. */ export type PriceListContextRule = { __typename?: 'PriceListContextRule'; /** A list of two letter country codes that determines price list eligibility. */ countries: Array; }; /** The context that the price list applies to. */ export type PriceListContextRuleInput = { /** The code for the country that the price list applies to. You can only specify one country code. */ countries?: Maybe>; }; /** Provides the fields and values to use when creating a price list. */ export type PriceListCreateInput = { /** The unique name of the price list, used as a human-readable identifier. */ name: Scalars['String']; /** Three letter currency code for fixed prices associated with this price list. */ currency: CurrencyCode; /** Relative adjustments to other prices. */ parent: PriceListParentCreateInput; /** A set of facts about the customer used to determine price list eligibility. */ contextRule?: Maybe; }; /** Return type for `priceListCreate` mutation. */ export type PriceListCreatePayload = { __typename?: 'PriceListCreatePayload'; /** The newly created price list. */ priceList?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `priceListDelete` mutation. */ export type PriceListDeletePayload = { __typename?: 'PriceListDeletePayload'; /** The ID of the deleted price list. */ deletedId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one PriceList and a cursor during pagination. */ export type PriceListEdge = { __typename?: 'PriceListEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of PriceListEdge. */ node: PriceList; }; /** Return type for `priceListFixedPricesAdd` mutation. */ export type PriceListFixedPricesAddPayload = { __typename?: 'PriceListFixedPricesAddPayload'; /** The prices that were added to the price list. */ prices?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `priceListFixedPricesDelete` mutation. */ export type PriceListFixedPricesDeletePayload = { __typename?: 'PriceListFixedPricesDeletePayload'; /** A list of deleted variant IDs for prices. */ deletedFixedPriceVariantIds?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Represents relative adjustments from one price list to other prices. * You can use a `PriceListParent` to specify an adjusted relative price using a percentage-based * adjustment. Adjusted prices work in conjunction with exchange rules and rounding. * * [Adjustment types](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/pricelistadjustmenttype) * support both percentage increases and decreases. */ export type PriceListParent = { __typename?: 'PriceListParent'; /** A price list adjustment. */ adjustment: PriceListAdjustment; }; /** Provides the fields and values to use when creating a price list parent adjustment. */ export type PriceListParentCreateInput = { /** Provides the fields and values to use when updating a price list parent adjustment. */ adjustment: PriceListAdjustmentInput; }; /** Relative adjustments to other prices. */ export type PriceListParentUpdateInput = { /** Provides the fields and values to use when updating a price list parent adjustment. */ adjustment: PriceListAdjustmentInput; }; /** * Represents information about pricing for a product variant * as defined on a price list, such as the price, compare at price, and origin type. You can use a PriceListPrice to specify a fixed price for a specific product variant. */ export type PriceListPrice = { __typename?: 'PriceListPrice'; /** The compare-at price of the product variant on this price list. */ compareAtPrice?: Maybe; /** * The origin of this price, either fixed (defined on the price list) * or relative (calculated using an adjustment via a price list parent configuration). */ originType: PriceListPriceOriginType; /** The price of the product variant on this price list. */ price: MoneyV2; /** The product variant associated with this price. */ variant: ProductVariant; }; /** An auto-generated type for paginating through multiple PriceListPrices. */ export type PriceListPriceConnection = { __typename?: 'PriceListPriceConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one PriceListPrice and a cursor during pagination. */ export type PriceListPriceEdge = { __typename?: 'PriceListPriceEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of PriceListPriceEdge. */ node: PriceListPrice; }; /** Provides the fields and values to use when creating or updating a fixed price list price. */ export type PriceListPriceInput = { /** The product variant ID associated with the price list price. */ variantId: Scalars['ID']; /** The price of the product variant on this price list. */ price: MoneyInput; /** The compare-at price of the product variant on this price list. */ compareAtPrice?: Maybe; }; /** * Represents the origin of a price, either fixed (defined on the price list) * or relative (calculated using an adjustment via a price list parent configuration). */ export enum PriceListPriceOriginType { /** The price is defined on the price list. */ Fixed = 'FIXED', /** The price is relative to the parent price list. */ Relative = 'RELATIVE' } /** Error codes for failed price list price operations. */ export type PriceListPriceUserError = DisplayableError & { __typename?: 'PriceListPriceUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by PriceListPriceUserError. */ export enum PriceListPriceUserErrorCode { /** Input value is blank. */ Blank = 'BLANK', /** Price list does not exist. */ PriceListNotFound = 'PRICE_LIST_NOT_FOUND', /** The specified currency does not match the price list's currency. */ PriceListCurrencyMismatch = 'PRICE_LIST_CURRENCY_MISMATCH', /** The Price for specified Variant does not exist. */ VariantNotFound = 'VARIANT_NOT_FOUND', /** Only fixed prices can be deleted. */ PriceNotFixed = 'PRICE_NOT_FIXED' } /** The set of valid sort keys for the PriceList query. */ export enum PriceListSortKeys { /** Sort by the `name` value. */ Name = 'NAME', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Provides the fields and values to use when updating a price list. */ export type PriceListUpdateInput = { /** The unique name of the price list, used as a human-readable identifier. */ name?: Maybe; /** The three-letter code for fixed prices associated with this price list. */ currency?: Maybe; /** A set of facts about buyer context used to determine price list eligibility. */ contextRule?: Maybe; /** Relative adjustments to other prices. */ parent?: Maybe; }; /** Return type for `priceListUpdate` mutation. */ export type PriceListUpdatePayload = { __typename?: 'PriceListUpdatePayload'; /** The updated price list. */ priceList?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Error codes for failed contextual pricing operations. */ export type PriceListUserError = DisplayableError & { __typename?: 'PriceListUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by PriceListUserError. */ export enum PriceListUserErrorCode { /** Input value is already taken. */ Taken = 'TAKEN', /** The PriceList specified does not exist. */ PriceListNotFound = 'PRICE_LIST_NOT_FOUND', /** Cannot save the price list with context rule because the limit of context rules per shop was reached. */ ContextRuleLimitReached = 'CONTEXT_RULE_LIMIT_REACHED', /** A price list context rule cannot have more than one country. */ ContextRuleCountriesLimit = 'CONTEXT_RULE_COUNTRIES_LIMIT', /** A price list’s currency must be of the pricing rule’s country. */ CurrencyCountryMismatch = 'CURRENCY_COUNTRY_MISMATCH', /** A country within a pricing rule must use a valid currency. */ CountryCurrencyMismatch = 'COUNTRY_CURRENCY_MISMATCH', /** The adjustment value must be a positive value. */ InvalidAdjustmentValue = 'INVALID_ADJUSTMENT_VALUE', /** A price list for this country is already taken. */ ContextRuleCountryTaken = 'CONTEXT_RULE_COUNTRY_TAKEN' } /** Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. */ export type PriceRule = Node & CommentEventSubject & LegacyInteroperability & HasEvents & { __typename?: 'PriceRule'; /** The maximum number of times that the price rule can be allocated onto an order. */ allocationLimit?: Maybe; /** The method by which the price rule's value is allocated to its entitled items. */ allocationMethod: PriceRuleAllocationMethod; /** The application that created the price rule. */ app?: Maybe; /** The date and time when the price rule was created. */ createdAt: Scalars['DateTime']; /** The customers that can use this price rule. */ customerSelection: PriceRuleCustomerSelection; /** List of the price rule's discount codes. */ discountCodes: PriceRuleDiscountCodeConnection; /** How many discount codes associated with the price rule. */ discountCodesCount: Scalars['Int']; /** The date and time when the price rule ends. For open-ended price rules, use `null`. */ endsAt?: Maybe; /** * Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. * @deprecated Use `prerequisiteToEntitlementQuantityRatio` instead */ entitlementToPrerequisiteQuantityRatio?: Maybe; /** The paginated list of events associated with the price rule. */ events: EventConnection; /** A list of the price rule's features. */ features: Array; /** Indicates whether there are any timeline comments on the price rule. */ hasTimelineComment: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** The items to which the price rule applies. */ itemEntitlements: PriceRuleItemEntitlements; /** The items required for the price rule to be applicable. */ itemPrerequisites: PriceRuleLineItemPrerequisites; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** Whether the price rule can be applied only once per customer. */ oncePerCustomer: Scalars['Boolean']; /** The number of the entitled items must fall within this range for the price rule to be applicable. */ prerequisiteQuantityRange?: Maybe; /** The shipping cost must fall within this range for the price rule to be applicable. */ prerequisiteShippingPriceRange?: Maybe; /** The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. */ prerequisiteSubtotalRange?: Maybe; /** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ prerequisiteToEntitlementQuantityRatio?: Maybe; /** URLs that can be used to share the discount. */ shareableUrls: Array; /** The shipping lines to which the price rule applies. */ shippingEntitlements: PriceRuleShippingLineEntitlements; /** The date and time when the price rule starts. */ startsAt: Scalars['DateTime']; /** The status of the price rule. */ status: PriceRuleStatus; /** A detailed summary of the price rule. */ summary?: Maybe; /** The type of lines (line_item or shipping_line) to which the price rule applies. */ target: PriceRuleTarget; /** The title of the price rule. */ title: Scalars['String']; /** The total sales from orders where the price rule was used. */ totalSales?: Maybe; /** * A list of the price rule's features. * @deprecated Use `features` instead */ traits: Array; /** The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. */ usageCount: Scalars['Int']; /** The maximum number of times that the price rule can be used in total. */ usageLimit?: Maybe; /** A time period during which a price rule is applicable. */ validityPeriod: PriceRuleValidityPeriod; /** * The value of the price rule. * @deprecated Use `valueV2` instead */ value: PriceRuleValue; /** The value of the price rule. */ valueV2: PricingValue; }; /** Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. */ export type PriceRuleDiscountCodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. */ export type PriceRuleEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Return type for `priceRuleActivate` mutation. */ export type PriceRuleActivatePayload = { __typename?: 'PriceRuleActivatePayload'; /** The activated price rule. */ priceRule?: Maybe; /** List of errors that occurred executing the mutation. */ priceRuleUserErrors: Array; /** * List of errors that occurred executing the mutation. * @deprecated Use `priceRuleUserErrors` instead */ userErrors: Array; }; /** The method by which the price rule's value is allocated to its entitled items. */ export enum PriceRuleAllocationMethod { /** The value will be applied to each of the entitled items. */ Each = 'EACH', /** The value will be applied once across the entitled items. */ Across = 'ACROSS' } /** An auto-generated type for paginating through multiple PriceRules. */ export type PriceRuleConnection = { __typename?: 'PriceRuleConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `priceRuleCreate` mutation. */ export type PriceRuleCreatePayload = { __typename?: 'PriceRuleCreatePayload'; /** The newly created price rule. */ priceRule?: Maybe; /** The newly created discount code. */ priceRuleDiscountCode?: Maybe; /** List of errors that occurred executing the mutation. */ priceRuleUserErrors: Array; /** * List of errors that occurred executing the mutation. * @deprecated Use `priceRuleUserErrors` instead */ userErrors: Array; }; /** A selection of customers for whom the price rule applies. */ export type PriceRuleCustomerSelection = { __typename?: 'PriceRuleCustomerSelection'; /** List of customers to whom the price rule applies. */ customers: CustomerConnection; /** Whether the price rule applies to all customers. */ forAllCustomers: Scalars['Boolean']; /** A list of customer saved searches that contain the customers who can use the price rule. */ savedSearches: Array; }; /** A selection of customers for whom the price rule applies. */ export type PriceRuleCustomerSelectionCustomersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Specifies the input fields to update a price rule customer selection. */ export type PriceRuleCustomerSelectionInput = { /** Whether the price rule applies to all customers. */ forAllCustomers?: Maybe; /** List of customer saved searches that contain the customers to whom the price rule applies. No single customer IDs may be present. */ savedSearchIds?: Maybe>; /** List of customers to add to the current list of customers to whom the price rule applies. `savedSearchIds` must be empty. */ customerIdsToAdd?: Maybe>; /** A list of customers to remove from the current list of customers to whom the price rule applies. */ customerIdsToRemove?: Maybe>; }; /** Return type for `priceRuleDeactivate` mutation. */ export type PriceRuleDeactivatePayload = { __typename?: 'PriceRuleDeactivatePayload'; /** The deactivated price rule. */ priceRule?: Maybe; /** List of errors that occurred executing the mutation. */ priceRuleUserErrors: Array; /** * List of errors that occurred executing the mutation. * @deprecated Use `priceRuleUserErrors` instead */ userErrors: Array; }; /** Return type for `priceRuleDelete` mutation. */ export type PriceRuleDeletePayload = { __typename?: 'PriceRuleDeletePayload'; /** The id price of the deleted price rule. */ deletedPriceRuleId?: Maybe; /** List of errors that occurred executing the mutation. */ priceRuleUserErrors: Array; /** The shop of the deleted price rule. */ shop: Shop; /** * List of errors that occurred executing the mutation. * @deprecated Use `priceRuleUserErrors` instead */ userErrors: Array; }; /** A discount code of a price rule. */ export type PriceRuleDiscountCode = Node & { __typename?: 'PriceRuleDiscountCode'; /** The application that created the discount code. */ app?: Maybe; /** The code to use the discount. */ code: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. */ usageCount: Scalars['Int']; }; /** An auto-generated type for paginating through multiple PriceRuleDiscountCodes. */ export type PriceRuleDiscountCodeConnection = { __typename?: 'PriceRuleDiscountCodeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `priceRuleDiscountCodeCreate` mutation. */ export type PriceRuleDiscountCodeCreatePayload = { __typename?: 'PriceRuleDiscountCodeCreatePayload'; /** The updated price rule. */ priceRule?: Maybe; /** The newly created discount code. */ priceRuleDiscountCode?: Maybe; /** List of errors that occurred executing the mutation. */ priceRuleUserErrors: Array; /** * List of errors that occurred executing the mutation. * @deprecated Use `priceRuleUserErrors` instead */ userErrors: Array; }; /** An auto-generated type which holds one PriceRuleDiscountCode and a cursor during pagination. */ export type PriceRuleDiscountCodeEdge = { __typename?: 'PriceRuleDiscountCodeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of PriceRuleDiscountCodeEdge. */ node: PriceRuleDiscountCode; }; /** Specifies the input fields to manipulate a discount code. */ export type PriceRuleDiscountCodeInput = { /** The code to use the discount. */ code?: Maybe; }; /** Return type for `priceRuleDiscountCodeUpdate` mutation. */ export type PriceRuleDiscountCodeUpdatePayload = { __typename?: 'PriceRuleDiscountCodeUpdatePayload'; /** The updated price rule. */ priceRule?: Maybe; /** The updated discount code. */ priceRuleDiscountCode?: Maybe; /** List of errors that occurred executing the mutation. */ priceRuleUserErrors: Array; /** * List of errors that occurred executing the mutation. * @deprecated Use `priceRuleUserErrors` instead */ userErrors: Array; }; /** An auto-generated type which holds one PriceRule and a cursor during pagination. */ export type PriceRuleEdge = { __typename?: 'PriceRuleEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of PriceRuleEdge. */ node: PriceRule; }; /** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ export type PriceRuleEntitlementToPrerequisiteQuantityRatio = { __typename?: 'PriceRuleEntitlementToPrerequisiteQuantityRatio'; /** The quantity of entitlements in the ratio. */ entitlementQuantity: Scalars['Int']; /** The quantity of prerequisites in the ratio. */ prerequisiteQuantity: Scalars['Int']; }; /** Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ export type PriceRuleEntitlementToPrerequisiteQuantityRatioInput = { /** The quantity of entitlements in the ratio. */ entitlementQuantity?: Maybe; /** The quantity of prerequisites in the ratio. */ prerequisiteQuantity?: Maybe; }; /** Possible error codes that could be returned by a price rule mutation. */ export enum PriceRuleErrorCode { /** Input value is blank. */ Blank = 'BLANK', /** Input value should be equal to allowed value. */ EqualTo = 'EQUAL_TO', /** Input value should be greater than minimum allowed value. */ GreaterThan = 'GREATER_THAN', /** Input value should be greater than or equal to minimum allowed value. */ GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', /** Input value is invalid. */ Invalid = 'INVALID', /** Input value should be less than maximum allowed value. */ LessThan = 'LESS_THAN', /** Input value should be less or equal to maximum allowed value. */ LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO', /** Input value is already taken. */ Taken = 'TAKEN', /** Input value is too long. */ TooLong = 'TOO_LONG', /** Input value is too short. */ TooShort = 'TOO_SHORT', /** Unexpected internal error happened. */ InternalError = 'INTERNAL_ERROR', /** Too many arguments provided. */ TooManyArguments = 'TOO_MANY_ARGUMENTS', /** Missing a required argument. */ MissingArgument = 'MISSING_ARGUMENT', /** Duplicate customer prerequisite id present. */ CustomerPrerequisiteDuplicate = 'CUSTOMER_PREREQUISITE_DUPLICATE', CannotEntitleCollectionsWithProductsOrVariants = 'CANNOT_ENTITLE_COLLECTIONS_WITH_PRODUCTS_OR_VARIANTS', ItemEntitlementInvalidType = 'ITEM_ENTITLEMENT_INVALID_TYPE', ItemEntitlementsDuplicateCollection = 'ITEM_ENTITLEMENTS_DUPLICATE_COLLECTION', ItemEntitlementsDuplicateProduct = 'ITEM_ENTITLEMENTS_DUPLICATE_PRODUCT', ItemEntitlementsDuplicateVariant = 'ITEM_ENTITLEMENTS_DUPLICATE_VARIANT', ItemEntitlementsExceededMaxCollection = 'ITEM_ENTITLEMENTS_EXCEEDED_MAX_COLLECTION', ItemEntitlementsExceededMaxProduct = 'ITEM_ENTITLEMENTS_EXCEEDED_MAX_PRODUCT', ItemEntitlementsExceededMaxVariant = 'ITEM_ENTITLEMENTS_EXCEEDED_MAX_VARIANT', ItemEntitlementsInvalidCollection = 'ITEM_ENTITLEMENTS_INVALID_COLLECTION', ItemEntitlementsInvalidProduct = 'ITEM_ENTITLEMENTS_INVALID_PRODUCT', ItemEntitlementsInvalidTargetTypeOrSelection = 'ITEM_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION', ItemEntitlementsInvalidVariant = 'ITEM_ENTITLEMENTS_INVALID_VARIANT', ItemEntitlementsMissing = 'ITEM_ENTITLEMENTS_MISSING', VariantAlreadyEntitledThroughProduct = 'VARIANT_ALREADY_ENTITLED_THROUGH_PRODUCT', CannotPrerequisiteCollectionWithProductOrVariants = 'CANNOT_PREREQUISITE_COLLECTION_WITH_PRODUCT_OR_VARIANTS', ItemPrerequisitesDuplicateCollection = 'ITEM_PREREQUISITES_DUPLICATE_COLLECTION', ItemPrerequisitesDuplicateProduct = 'ITEM_PREREQUISITES_DUPLICATE_PRODUCT', ItemPrerequisitesDuplicateVariant = 'ITEM_PREREQUISITES_DUPLICATE_VARIANT', ItemPrerequisitesExceededMax = 'ITEM_PREREQUISITES_EXCEEDED_MAX', ItemPrerequisitesInvalidCollection = 'ITEM_PREREQUISITES_INVALID_COLLECTION', ItemPrerequisitesInvalidProduct = 'ITEM_PREREQUISITES_INVALID_PRODUCT', ItemPrerequisitesInvalidType = 'ITEM_PREREQUISITES_INVALID_TYPE', ItemPrerequisitesInvalidVariant = 'ITEM_PREREQUISITES_INVALID_VARIANT', ItemPrerequisitesMissing = 'ITEM_PREREQUISITES_MISSING', ItemPrerequisitesMustBeEmpty = 'ITEM_PREREQUISITES_MUST_BE_EMPTY', InvalidTargetTypePrerequisiteShippingPriceRange = 'INVALID_TARGET_TYPE_PREREQUISITE_SHIPPING_PRICE_RANGE', ShippingEntitlementsDuplicateCountry = 'SHIPPING_ENTITLEMENTS_DUPLICATE_COUNTRY', ShippingEntitlementsExceededMax = 'SHIPPING_ENTITLEMENTS_EXCEEDED_MAX', ShippingEntitlementsInvalidCountry = 'SHIPPING_ENTITLEMENTS_INVALID_COUNTRY', ShippingEntitlementsInvalidTargetTypeOrSelection = 'SHIPPING_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION', ShippingEntitlementsMissing = 'SHIPPING_ENTITLEMENTS_MISSING', ShippingEntitlementsUnsupportedDestinationType = 'SHIPPING_ENTITLEMENTS_UNSUPPORTED_DESTINATION_TYPE', BothCustomerAndSavedSearchPrerequisitesSelected = 'BOTH_CUSTOMER_AND_SAVED_SEARCH_PREREQUISITES_SELECTED', CustomerPrerequisitesExceededMax = 'CUSTOMER_PREREQUISITES_EXCEEDED_MAX', CustomerPrerequisitesInvalidSelection = 'CUSTOMER_PREREQUISITES_INVALID_SELECTION', CustomerPrerequisitesMissing = 'CUSTOMER_PREREQUISITES_MISSING', CustomerSavedSearchDuplicate = 'CUSTOMER_SAVED_SEARCH_DUPLICATE', CustomerSavedSearchExceededMax = 'CUSTOMER_SAVED_SEARCH_EXCEEDED_MAX', CustomerSavedSearchInvalid = 'CUSTOMER_SAVED_SEARCH_INVALID', DiscountCodeDuplicate = 'DISCOUNT_CODE_DUPLICATE', BogoInvalidTargetSelection = 'BOGO_INVALID_TARGET_SELECTION', BogoInvalidTargetType = 'BOGO_INVALID_TARGET_TYPE', BogoInvalidValueType = 'BOGO_INVALID_VALUE_TYPE', /** Allocation limit can only be set on buy one get one type discounts. */ PriceRuleAllocationLimitOnNonBogo = 'PRICE_RULE_ALLOCATION_LIMIT_ON_NON_BOGO', /** Allocation limit must be a non zero positive number. */ PriceRuleAllocationLimitIsZero = 'PRICE_RULE_ALLOCATION_LIMIT_IS_ZERO', /** Number of discount codes in the shop has reached its limit. */ PriceRuleExceededMaxDiscountCode = 'PRICE_RULE_EXCEEDED_MAX_DISCOUNT_CODE', /** Number of discounts in the shop has reached its limit. */ ShopExceededMaxPriceRules = 'SHOP_EXCEEDED_MAX_PRICE_RULES', /** Discount end date must be after the start date. */ EndDateBeforeStartDate = 'END_DATE_BEFORE_START_DATE', /** Percentage value must be between 0 and -100. */ PriceRulePercentageValueOutsideRange = 'PRICE_RULE_PERCENTAGE_VALUE_OUTSIDE_RANGE', /** Only one of minimum subtotal or minimum quantity condition can be defined. */ PrerequisiteSubtotalAndQuantityRangeBothPresent = 'PREREQUISITE_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT', /** Allocation method must be "across" for the provided target selection. */ AllocationMethodMustBeAcrossForGivenTargetSelection = 'ALLOCATION_METHOD_MUST_BE_ACROSS_FOR_GIVEN_TARGET_SELECTION', /** Discount must apply on either one time purchase or subscription items, or both. */ AppliesOnNothing = 'APPLIES_ON_NOTHING', /** Recurring cycle limit must be 1 when a discount does not apply on subscription items. */ MultipleRecurringCycleLimitForNonSubscriptionItems = 'MULTIPLE_RECURRING_CYCLE_LIMIT_FOR_NON_SUBSCRIPTION_ITEMS', /** Exceeds maximum number allowed. */ ExceededMax = 'EXCEEDED_MAX' } /** A list of features used by the price rule. */ export enum PriceRuleFeature { /** The price rule supports quantity BXGY discounts. */ BuyOneGetOne = 'BUY_ONE_GET_ONE', /** The price rule supports BXGY discounts using custom allocation limit. */ BuyOneGetOneWithAllocationLimit = 'BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT', /** The price rule supports bulk discounts. */ Bulk = 'BULK', /** The price rule supports specific customers. */ SpecificCustomers = 'SPECIFIC_CUSTOMERS', /** The price rule supports quantity discounts. */ QuantityDiscounts = 'QUANTITY_DISCOUNTS' } /** The value of a fixed amount price rule. */ export type PriceRuleFixedAmountValue = { __typename?: 'PriceRuleFixedAmountValue'; /** The monetary value of the price rule. */ amount: Scalars['Money']; }; /** Specifies the input fields to manipulate a price rule. */ export type PriceRuleInput = { /** PriceRuleValidityPeriod for the price rule. */ validityPeriod?: Maybe; /** Whether the price rule can be applied only once per customer. */ oncePerCustomer?: Maybe; /** The customers that can use this price rule. */ customerSelection?: Maybe; /** The maximum number of times that the price rule can be used in total. */ usageLimit?: Maybe; /** Title of the price rule. */ title?: Maybe; /** The maximum number of times that the price rule can be allocated onto an order. */ allocationLimit?: Maybe; /** The method by which the price rule's value is allocated to its entitled items. */ allocationMethod?: Maybe; /** The value of the price rule. */ value?: Maybe; /** The type of lines (line_item or shipping_line) to which the price rule applies. */ target?: Maybe; /** The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. */ prerequisiteSubtotalRange?: Maybe; /** The number of the entitled items must fall within this range for the price rule to be applicable. */ prerequisiteQuantityRange?: Maybe; /** The shipping cost must fall within this range for the price rule to be applicable. */ prerequisiteShippingPriceRange?: Maybe; /** The items to which the price rule applies. */ itemEntitlements?: Maybe; /** The items required for the price rule to be applicable. */ itemPrerequisites?: Maybe; /** The shipping lines to which the price rule applies. */ shippingEntitlements?: Maybe; /** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use `prerequisiteToEntitlementQuantityRatio` instead. */ entitlementToPrerequisiteQuantityRatio?: Maybe; /** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ prerequisiteToEntitlementQuantityRatio?: Maybe; }; /** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ export type PriceRuleItemEntitlements = { __typename?: 'PriceRuleItemEntitlements'; /** The collections to which the price rule applies. */ collections: CollectionConnection; /** The product variants to which the price rule applies. */ productVariants: ProductVariantConnection; /** The products to which the price rule applies. */ products: ProductConnection; /** Whether the price rule applies to all line items. */ targetAllLineItems: Scalars['Boolean']; }; /** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ export type PriceRuleItemEntitlementsCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ export type PriceRuleItemEntitlementsProductVariantsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ export type PriceRuleItemEntitlementsProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Specifies the input fields to update a price rule line item entitlement. */ export type PriceRuleItemEntitlementsInput = { /** Whether the price rule applies to all items. */ targetAllLineItems?: Maybe; /** The products to which the price rule applies. */ productIds?: Maybe>; /** The product variants to which the price rule applies. */ productVariantIds?: Maybe>; /** The collections to which the price rule applies. */ collectionIds?: Maybe>; }; /** Specifies the input fields to update a price rule's item prerequisites. */ export type PriceRuleItemPrerequisitesInput = { /** The products needed for the price rule to be applied. */ productIds?: Maybe>; /** The product variants needed for the price rule to be applied. */ productVariantIds?: Maybe>; /** The collections needed for the price rule to be applied. */ collectionIds?: Maybe>; }; /** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ export type PriceRuleLineItemPrerequisites = { __typename?: 'PriceRuleLineItemPrerequisites'; /** The collections required for the price rule to be applicable. */ collections: CollectionConnection; /** The product variants required for the price rule to be applicable. */ productVariants: ProductVariantConnection; /** The products required for the price rule to be applicable. */ products: ProductConnection; }; /** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ export type PriceRuleLineItemPrerequisitesCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ export type PriceRuleLineItemPrerequisitesProductVariantsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ export type PriceRuleLineItemPrerequisitesProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** A money range within which the price rule is applicable. */ export type PriceRuleMoneyRange = { __typename?: 'PriceRuleMoneyRange'; /** The lower bound of the money range. */ greaterThan?: Maybe; /** The lower bound or equal of the money range. */ greaterThanOrEqualTo?: Maybe; /** The upper bound of the money range. */ lessThan?: Maybe; /** The upper bound or equal of the money range. */ lessThanOrEqualTo?: Maybe; }; /** Specifies the input fields to update the money range within which the price rule is applicable. */ export type PriceRuleMoneyRangeInput = { /** The upper bound of the money range. */ lessThan?: Maybe; /** The upper or equal bound of the money range. */ lessThanOrEqualTo?: Maybe; /** The lower bound of the money range. */ greaterThan?: Maybe; /** The lower or equal bound of the money range. */ greaterThanOrEqualTo?: Maybe; }; /** The value of a percent price rule. */ export type PriceRulePercentValue = { __typename?: 'PriceRulePercentValue'; /** The percent value of the price rule. */ percentage: Scalars['Float']; }; /** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ export type PriceRulePrerequisiteToEntitlementQuantityRatio = { __typename?: 'PriceRulePrerequisiteToEntitlementQuantityRatio'; /** The quantity of entitlements in the ratio. */ entitlementQuantity: Scalars['Int']; /** The quantity of prerequisites in the ratio. */ prerequisiteQuantity: Scalars['Int']; }; /** Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ export type PriceRulePrerequisiteToEntitlementQuantityRatioInput = { /** The quantity of entitlements in the ratio. */ entitlementQuantity?: Maybe; /** The quantity of prerequisites in the ratio. */ prerequisiteQuantity?: Maybe; }; /** A quantity range within which the price rule is applicable. */ export type PriceRuleQuantityRange = { __typename?: 'PriceRuleQuantityRange'; /** The lower bound of the quantity range. */ greaterThan?: Maybe; /** The lower bound or equal of the quantity range. */ greaterThanOrEqualTo?: Maybe; /** The upper bound of the quantity range. */ lessThan?: Maybe; /** The upper bound or equal of the quantity range. */ lessThanOrEqualTo?: Maybe; }; /** Specifies the input fields to update the quantity range within which the price rule is applicable. */ export type PriceRuleQuantityRangeInput = { /** The upper bound of the quantity range. */ lessThan?: Maybe; /** The upper or equal bound of the quantity range. */ lessThanOrEqualTo?: Maybe; /** The lower bound of the quantity range. */ greaterThan?: Maybe; /** The lower or equal bound of the quantity range. */ greaterThanOrEqualTo?: Maybe; }; /** Shareable URL for the discount code associated with the price rule. */ export type PriceRuleShareableUrl = { __typename?: 'PriceRuleShareableUrl'; /** The image URL of the item (product or collection) to which the discount applies. */ targetItemImage?: Maybe; /** The type of page that's associated with the URL. */ targetType: PriceRuleShareableUrlTargetType; /** The title of the page that's associated with the URL. */ title: Scalars['String']; /** The URL for the discount code. */ url: Scalars['URL']; }; /** Page type where shareable URL lands. */ export enum PriceRuleShareableUrlTargetType { Home = 'HOME', Product = 'PRODUCT', Collection = 'COLLECTION' } /** Specifies the input fields to update a price rule shipping entitlement. */ export type PriceRuleShippingEntitlementsInput = { /** Whether the price rule applies to all shipping lines. */ targetAllShippingLines?: Maybe; /** The codes for the countries to which the price rule applies to. */ countryCodes?: Maybe>; /** Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones. */ includeRestOfWorld?: Maybe; }; /** The shipping lines to which the price rule applies to. */ export type PriceRuleShippingLineEntitlements = { __typename?: 'PriceRuleShippingLineEntitlements'; /** The codes for the countries to which the price rule applies to. */ countryCodes: Array; /** Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones. */ includeRestOfWorld: Scalars['Boolean']; /** Whether the price rule applies to all shipping lines. */ targetAllShippingLines: Scalars['Boolean']; }; /** The set of valid sort keys for the PriceRule query. */ export enum PriceRuleSortKeys { /** Sort by the `starts_at` value. */ StartsAt = 'STARTS_AT', /** Sort by the `ends_at` value. */ EndsAt = 'ENDS_AT', /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The status of the price rule. */ export enum PriceRuleStatus { Active = 'ACTIVE', Expired = 'EXPIRED', Scheduled = 'SCHEDULED' } /** The type of lines (line_item or shipping_line) to which the price rule applies. */ export enum PriceRuleTarget { /** The price rule applies to line items. */ LineItem = 'LINE_ITEM', /** The price rule applies to shipping lines. */ ShippingLine = 'SHIPPING_LINE' } /** A list of features used by the price rule. */ export enum PriceRuleTrait { /** The price rule supports quantity BXGY discounts. */ BuyOneGetOne = 'BUY_ONE_GET_ONE', /** The price rule supports BXGY discounts using custom allocation limit. */ BuyOneGetOneWithAllocationLimit = 'BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT', /** The price rule supports bulk discounts. */ Bulk = 'BULK', /** The price rule supports specific customers. */ SpecificCustomers = 'SPECIFIC_CUSTOMERS', /** The price rule supports quantity discounts. */ QuantityDiscounts = 'QUANTITY_DISCOUNTS' } /** Return type for `priceRuleUpdate` mutation. */ export type PriceRuleUpdatePayload = { __typename?: 'PriceRuleUpdatePayload'; /** The updated price rule. */ priceRule?: Maybe; /** The updated discount code. */ priceRuleDiscountCode?: Maybe; /** List of errors that occurred executing the mutation. */ priceRuleUserErrors: Array; /** * List of errors that occurred executing the mutation. * @deprecated Use `priceRuleUserErrors` instead */ userErrors: Array; }; /** Represents an error that happens during execution of a price rule mutation. */ export type PriceRuleUserError = DisplayableError & { __typename?: 'PriceRuleUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** A time period during which a price rule is applicable. */ export type PriceRuleValidityPeriod = { __typename?: 'PriceRuleValidityPeriod'; /** The time after which the price rule becomes invalid. */ end?: Maybe; /** The time after which the price rule is valid. */ start: Scalars['DateTime']; }; /** Specifies the input fields to update the validity period of a price rule. */ export type PriceRuleValidityPeriodInput = { /** The time after which the price rule is valid. */ start: Scalars['DateTime']; /** The time after which the price rule becomes invalid. */ end?: Maybe; }; /** The value of the price rule. */ export type PriceRuleValue = PriceRuleFixedAmountValue | PriceRulePercentValue; /** Specifies the input fields to update a price rule. */ export type PriceRuleValueInput = { /** The percentage value of the price rule. */ percentageValue?: Maybe; /** The fixed amount value of the price rule. */ fixedAmountValue?: Maybe; }; /** The value of the percentage pricing object. */ export type PricingPercentageValue = { __typename?: 'PricingPercentageValue'; /** The percentage value of the object. */ percentage: Scalars['Float']; }; /** The value of the pricing object. */ export type PricingValue = MoneyV2 | PricingPercentageValue; /** * Private metafields represent custom metadata that is attached to a resource. * Private metafields are private to the application that creates them on a shop's resources. */ export type PrivateMetafield = Node & { __typename?: 'PrivateMetafield'; /** The date and time when the private metafield was created. */ createdAt: Scalars['DateTime']; /** The id of the private metafield. */ id: Scalars['ID']; /** The key name for a private metafield. */ key: Scalars['String']; /** The namespace for a private metafield. */ namespace: Scalars['String']; /** The date and time when the private metafield was updated. */ updatedAt: Scalars['DateTime']; /** The value of a private metafield. */ value: Scalars['String']; /** Represents the private metafield value type. */ valueType: PrivateMetafieldValueType; }; /** An auto-generated type for paginating through multiple PrivateMetafields. */ export type PrivateMetafieldConnection = { __typename?: 'PrivateMetafieldConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Specifies the input fields for a PrivateMetafield. */ export type PrivateMetafieldDeleteInput = { /** The ID of the owning resource. */ owner?: Maybe; /** The namespace for the private metafield. */ namespace: Scalars['String']; /** The key for the private metafield. */ key: Scalars['String']; }; /** Return type for `privateMetafieldDelete` mutation. */ export type PrivateMetafieldDeletePayload = { __typename?: 'PrivateMetafieldDeletePayload'; /** The ID of private metafield that was deleted. */ deletedPrivateMetafieldId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one PrivateMetafield and a cursor during pagination. */ export type PrivateMetafieldEdge = { __typename?: 'PrivateMetafieldEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of PrivateMetafieldEdge. */ node: PrivateMetafield; }; /** Specifies the input fields for a PrivateMetafield. */ export type PrivateMetafieldInput = { /** The owning resource. */ owner?: Maybe; /** The namespace for the private metafield. */ namespace: Scalars['String']; /** The key for the private metafield. */ key: Scalars['String']; /** The value and value type of the metafield, wrapped in a ValueInput object. */ valueInput: PrivateMetafieldValueInput; }; /** Return type for `privateMetafieldUpsert` mutation. */ export type PrivateMetafieldUpsertPayload = { __typename?: 'PrivateMetafieldUpsertPayload'; /** The private metafield that was created or updated. */ privateMetafield?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Value Input wraps two fields of Private Metafields into one. Those fields are value and value_type. */ export type PrivateMetafieldValueInput = { /** The value of a private metafield. */ value: Scalars['String']; /** Represents the private metafield value type. */ valueType: PrivateMetafieldValueType; }; /** Private Metafield value types. */ export enum PrivateMetafieldValueType { /** A string metafield. */ String = 'STRING', /** An integer metafield. */ Integer = 'INTEGER', /** A JSON string metafield. */ JsonString = 'JSON_STRING' } /** Represents a product, including information about related collections and product variants. */ export type Product = Node & Navigable & HasMetafields & HasPublishedTranslations & Publishable & OnlineStorePreviewable & LegacyInteroperability & { __typename?: 'Product'; /** The number of publications a resource is published to without feedback errors. */ availablePublicationCount: Scalars['Int']; /** * The description of the product, complete with HTML formatting. * @deprecated Use `descriptionHtml` instead */ bodyHtml?: Maybe; /** A list of the collections that include the product. */ collections: CollectionConnection; /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created. */ createdAt: Scalars['DateTime']; /** A default cursor that returns the single next record, sorted ascending by ID. */ defaultCursor: Scalars['String']; /** A stripped description of the product, single line with HTML tags removed. */ description: Scalars['String']; /** The description of the product, complete with HTML formatting. */ descriptionHtml: Scalars['HTML']; /** * Stripped description of the product, single line with HTML tags removed. * Truncated to 60 characters. * @deprecated Use `description` instead */ descriptionPlainSummary: Scalars['String']; /** The featured image for the product. */ featuredImage?: Maybe; /** The featured media for the product. */ featuredMedia?: Maybe; /** Information about the product that's provided through resource feedback. */ feedback?: Maybe; /** The theme template used when viewing the gift card in a store. */ giftCardTemplateSuffix?: Maybe; /** A unique human-friendly string of the product's title. */ handle: Scalars['String']; /** Whether the product has only a single variant with the default option and value. */ hasOnlyDefaultVariant: Scalars['Boolean']; /** Whether the product has out of stock variants. */ hasOutOfStockVariants: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** The images associated with the product. */ images: ImageConnection; /** Whether the product is in a given collection. */ inCollection: Scalars['Boolean']; /** Whether the product is a gift card. */ isGiftCard: Scalars['Boolean']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The media associated with the product. */ media: MediaConnection; /** Total count of media belonging to a product. */ mediaCount: Scalars['Int']; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** The online store preview URL. */ onlineStorePreviewUrl?: Maybe; /** * The online store URL for the product. * A value of `null` indicates that the product is not published to the Online Store sales channel. */ onlineStoreUrl?: Maybe; /** A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions. */ options: Array; /** * The price range of the product. * @deprecated Deprecated in API version 2020-10. Use `priceRangeV2` instead. */ priceRange: ProductPriceRange; /** The price range of the product with prices formatted as decimals. */ priceRangeV2: ProductPriceRangeV2; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** * A list of the channels where the product is published. * @deprecated Use `resourcePublications` instead */ productPublications: ProductPublicationConnection; /** The product type specified by the merchant. */ productType: Scalars['String']; /** The number of publications a resource is published on. */ publicationCount: Scalars['Int']; /** * A list of the channels where the product is published. * @deprecated Use `resourcePublications` instead */ publications: ProductPublicationConnection; /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was published to the Online Store. */ publishedAt?: Maybe; /** * Check to see whether the resource is published to a given channel. * @deprecated Use `publishedOnPublication` instead */ publishedOnChannel: Scalars['Boolean']; /** * Check to see whether the resource is published to the calling app's channel. * @deprecated Use `publishedOnCurrentPublication` instead */ publishedOnCurrentChannel: Scalars['Boolean']; /** Check to see whether the resource is published to the calling app's publication. */ publishedOnCurrentPublication: Scalars['Boolean']; /** Check to see whether the resource is published to a given publication. */ publishedOnPublication: Scalars['Boolean']; /** Whether the product can only be purchased with a selling plan. */ requiresSellingPlan: Scalars['Boolean']; /** The list of resources that are published to a publication. */ resourcePublications: ResourcePublicationConnection; /** The list of resources that are either published or staged to be published to a publication. */ resourcePublicationsV2: ResourcePublicationV2Connection; /** Count of selling plan groups associated with the product. */ sellingPlanGroupCount: Scalars['Int']; /** SEO information of the product. */ seo: Seo; /** The product status. */ status: ProductStatus; /** The storefront ID of the product. */ storefrontId: Scalars['StorefrontID']; /** * A comma separated list of tags associated with the product. Updating `tags` overwrites * any existing tags that were previously added to the product. To add new tags without overwriting * existing tags, use the [tagsAdd](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/tagsadd) * mutation. */ tags: Array; /** The theme template used when viewing the product in a store. */ templateSuffix?: Maybe; /** The title of the product. */ title: Scalars['String']; /** The quantity of inventory in stock. */ totalInventory: Scalars['Int']; /** The number of variants that are associated with the product. */ totalVariants: Scalars['Int']; /** Whether inventory tracking has been enabled for the product. */ tracksInventory: Scalars['Boolean']; /** The translations associated with the resource. */ translations: Array; /** * The list of channels that the resource is not published to. * @deprecated Use `unpublishedPublications` instead */ unpublishedChannels: ChannelConnection; /** The list of publications that the resource is not published to. */ unpublishedPublications: PublicationConnection; /** * The date and time when the product was last modified. * A product's `updatedAt` value can change for different reasons. For example, if an order * is placed for a product that has inventory tracking set up, then the inventory adjustment * is counted as an update. */ updatedAt: Scalars['DateTime']; /** A list of variants associated with the product. */ variants: ProductVariantConnection; /** The name of the product's vendor. */ vendor: Scalars['String']; }; /** Represents a product, including information about related collections and product variants. */ export type ProductCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductDescriptionArgs = { truncateAt?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductImagesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductInCollectionArgs = { id: Scalars['ID']; }; /** Represents a product, including information about related collections and product variants. */ export type ProductMediaArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a product, including information about related collections and product variants. */ export type ProductMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductOptionsArgs = { first?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a product, including information about related collections and product variants. */ export type ProductPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductProductPublicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductPublicationCountArgs = { onlyPublished?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductPublicationsArgs = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductPublishedOnChannelArgs = { channelId: Scalars['ID']; }; /** Represents a product, including information about related collections and product variants. */ export type ProductPublishedOnPublicationArgs = { publicationId: Scalars['ID']; }; /** Represents a product, including information about related collections and product variants. */ export type ProductResourcePublicationsArgs = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductResourcePublicationsV2Args = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductTranslationsArgs = { locale: Scalars['String']; }; /** Represents a product, including information about related collections and product variants. */ export type ProductUnpublishedChannelsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductUnpublishedPublicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product, including information about related collections and product variants. */ export type ProductVariantsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Specifies product images to append. */ export type ProductAppendImagesInput = { /** The ID of the product. */ id: Scalars['ID']; /** The images to be appended to the product. */ images: Array; }; /** Return type for `productAppendImages` mutation. */ export type ProductAppendImagesPayload = { __typename?: 'ProductAppendImagesPayload'; /** List of new images appended to the product. */ newImages?: Maybe>; /** The product object. */ product?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productAppendImages` mutation. */ export type ProductAppendImagesPayloadNewImagesArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Return type for `productChangeStatus` mutation. */ export type ProductChangeStatusPayload = { __typename?: 'ProductChangeStatusPayload'; /** The product object. */ product?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of ProductChangeStatus. */ export type ProductChangeStatusUserError = DisplayableError & { __typename?: 'ProductChangeStatusUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by ProductChangeStatusUserError. */ export enum ProductChangeStatusUserErrorCode { /** Product could not be found. */ ProductNotFound = 'PRODUCT_NOT_FOUND' } /** The set of valid sort keys for the ProductCollection query. */ export enum ProductCollectionSortKeys { /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `price` value. */ Price = 'PRICE', /** Sort by the `best-selling` value. */ BestSelling = 'BEST_SELLING', /** Sort by the `created` value. */ Created = 'CREATED', /** Sort by the `id` value. */ Id = 'ID', /** Sort by the `manual` value. */ Manual = 'MANUAL', /** Sort by the `collection-default` value. */ CollectionDefault = 'COLLECTION_DEFAULT', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** An auto-generated type for paginating through multiple Products. */ export type ProductConnection = { __typename?: 'ProductConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `productCreateMedia` mutation. */ export type ProductCreateMediaPayload = { __typename?: 'ProductCreateMediaPayload'; /** The newly created media. */ media?: Maybe>; /** List of errors that occurred executing the mutation. */ mediaUserErrors: Array; /** The product associated with the media. */ product?: Maybe; /** * List of errors that occurred executing the mutation. * @deprecated Use `mediaUserErrors` instead */ userErrors: Array; }; /** Return type for `productCreate` mutation. */ export type ProductCreatePayload = { __typename?: 'ProductCreatePayload'; /** The product object. */ product?: Maybe; /** The shop associated with the product. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productDeleteImages` mutation. */ export type ProductDeleteImagesPayload = { __typename?: 'ProductDeleteImagesPayload'; /** This is an array of IDs of images to delete. */ deletedImageIds: Array; /** This is the product object. */ product?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the product to delete. */ export type ProductDeleteInput = { /** The ID of the product. */ id: Scalars['ID']; }; /** Return type for `productDeleteMedia` mutation. */ export type ProductDeleteMediaPayload = { __typename?: 'ProductDeleteMediaPayload'; /** List of media IDs which were deleted. */ deletedMediaIds?: Maybe>; /** List of product image IDs which were deleted. */ deletedProductImageIds?: Maybe>; /** List of errors that occurred executing the mutation. */ mediaUserErrors: Array; /** The product which media was deleted from. */ product?: Maybe; /** * List of errors that occurred executing the mutation. * @deprecated Use `mediaUserErrors` instead */ userErrors: Array; }; /** Return type for `productDelete` mutation. */ export type ProductDeletePayload = { __typename?: 'ProductDeletePayload'; /** The ID of the deleted product. */ deletedProductId?: Maybe; /** The shop associated with the product. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productDuplicate` mutation. */ export type ProductDuplicatePayload = { __typename?: 'ProductDuplicatePayload'; /** The asynchronous job duplicating the product images. */ imageJob?: Maybe; /** The duplicated product. */ newProduct?: Maybe; /** The user's shop. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one Product and a cursor during pagination. */ export type ProductEdge = { __typename?: 'ProductEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ProductEdge. */ node: Product; }; /** The set of valid sort keys for the ProductImage query. */ export enum ProductImageSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `position` value. */ Position = 'POSITION', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Return type for `productImageUpdate` mutation. */ export type ProductImageUpdatePayload = { __typename?: 'ProductImageUpdatePayload'; /** Image updated. */ image?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productImageUpdate` mutation. */ export type ProductImageUpdatePayloadImageArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Specifies the input fields required to create a product. */ export type ProductInput = { /** The description of the product, complete with HTML formatting. */ descriptionHtml?: Maybe; /** A unique human-friendly string for the product. Automatically generated from the product's title. */ handle?: Maybe; /** * Whether a redirect is required after a new handle has been provided. * If true, then the old handle is redirected to the new one automatically. */ redirectNewHandle?: Maybe; /** The SEO information associated with the product. */ seo?: Maybe; /** The product type specified by the merchant. */ productType?: Maybe; /** A comma separated list tags that have been added to the product. */ tags?: Maybe>; /** The theme template used when viewing the product in a store. */ templateSuffix?: Maybe; /** Whether the product is a gift card. */ giftCard?: Maybe; /** The theme template used when viewing the gift card in a store. */ giftCardTemplateSuffix?: Maybe; /** The title of the product. */ title?: Maybe; /** The name of the product's vendor. */ vendor?: Maybe; /** A description of the product. Supports HTML formatting. This argument is deprecated: Use `descriptionHtml` instead. */ bodyHtml?: Maybe; /** The IDs of the collections that this product will be added to. */ collectionsToJoin?: Maybe>; /** The IDs of collections that will no longer include the product. */ collectionsToLeave?: Maybe>; /** Specifies the product to update in productUpdate or creates a new product if absent in productCreate. */ id?: Maybe; /** The images to associate with the product. */ images?: Maybe>; /** The metafields to associate with this product. */ metafields?: Maybe>; /** The private metafields to associated with this product. */ privateMetafields?: Maybe>; /** List of custom product options (maximum of 3 per product). */ options?: Maybe>; /** A list of the channels where the product is published. This argument is deprecated: Use `PublishablePublish` instead. */ productPublications?: Maybe>; /** A list of the channels where the product is published. This argument is deprecated: Use `PublishablePublish` instead. */ publications?: Maybe>; /** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */ publishDate?: Maybe; /** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */ publishOn?: Maybe; /** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */ published?: Maybe; /** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */ publishedAt?: Maybe; /** A list of variants associated with the product. */ variants?: Maybe>; /** The status of the product. */ status?: Maybe; /** Whether the product can only be purchased with a selling plan. If set to `true` on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions. */ requiresSellingPlan?: Maybe; }; /** Return type for `productJoinSellingPlanGroups` mutation. */ export type ProductJoinSellingPlanGroupsPayload = { __typename?: 'ProductJoinSellingPlanGroupsPayload'; /** The product object. */ product?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productLeaveSellingPlanGroups` mutation. */ export type ProductLeaveSellingPlanGroupsPayload = { __typename?: 'ProductLeaveSellingPlanGroupsPayload'; /** The product object. */ product?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The set of valid sort keys for the ProductMedia query. */ export enum ProductMediaSortKeys { /** Sort by the `position` value. */ Position = 'POSITION', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** * Product property names like "Size", "Color", and "Material". * Variants are selected based on permutations of these options. * 255 characters limit each. */ export type ProductOption = Node & HasPublishedTranslations & { __typename?: 'ProductOption'; /** Globally unique identifier. */ id: Scalars['ID']; /** The product option’s name. */ name: Scalars['String']; /** The product option's position. */ position: Scalars['Int']; /** The translations associated with the resource. */ translations: Array; /** The corresponding value to the product option name. */ values: Array; }; /** * Product property names like "Size", "Color", and "Material". * Variants are selected based on permutations of these options. * 255 characters limit each. */ export type ProductOptionTranslationsArgs = { locale: Scalars['String']; }; /** The price range of the product. */ export type ProductPriceRange = { __typename?: 'ProductPriceRange'; /** The highest variant's price. */ maxVariantPrice: MoneyV2; /** The lowest variant's price. */ minVariantPrice: MoneyV2; }; /** The price range of the product. */ export type ProductPriceRangeV2 = { __typename?: 'ProductPriceRangeV2'; /** The highest variant's price. */ maxVariantPrice: MoneyV2; /** The lowest variant's price. */ minVariantPrice: MoneyV2; }; /** Represents the channels where a product is published. */ export type ProductPublication = { __typename?: 'ProductPublication'; /** The channel where the product was or is published. */ channel: Channel; /** Whether the publication is published or not. */ isPublished: Scalars['Boolean']; /** The product that was or is going to be published on the channel. */ product: Product; /** The date that the product was or is going to be published on the channel. */ publishDate?: Maybe; }; /** An auto-generated type for paginating through multiple ProductPublications. */ export type ProductPublicationConnection = { __typename?: 'ProductPublicationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ProductPublication and a cursor during pagination. */ export type ProductPublicationEdge = { __typename?: 'ProductPublicationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ProductPublicationEdge. */ node: ProductPublication; }; /** Specifies a publication to which a product will be published. */ export type ProductPublicationInput = { /** ID of the publication. */ publicationId?: Maybe; /** ID of the channel. This argument is deprecated: Use publicationId instead. */ channelId?: Maybe; /** This argument is deprecated: Use publicationId instead. */ channelHandle?: Maybe; /** The date and time that the product was (or will be) published. */ publishDate?: Maybe; }; /** Specifies a product to publish and the channels to publish it to. */ export type ProductPublishInput = { /** The product to create or update publications for. */ id: Scalars['ID']; /** The publication that the product is published to. */ productPublications: Array; }; /** Return type for `productPublish` mutation. */ export type ProductPublishPayload = { __typename?: 'ProductPublishPayload'; /** The product that has been published. */ product?: Maybe; /** * The channels where the product is published. * @deprecated Use Product.publications instead. */ productPublications?: Maybe>; /** The user's shop. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productReorderImages` mutation. */ export type ProductReorderImagesPayload = { __typename?: 'ProductReorderImagesPayload'; /** The asynchronous job reordering the images. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productReorderMedia` mutation. */ export type ProductReorderMediaPayload = { __typename?: 'ProductReorderMediaPayload'; /** The asynchronous job reordering the media. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ mediaUserErrors: Array; /** * List of errors that occurred executing the mutation. * @deprecated Use `mediaUserErrors` instead */ userErrors: Array; }; /** The set of valid sort keys for the Product query. */ export enum ProductSortKeys { /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `product_type` value. */ ProductType = 'PRODUCT_TYPE', /** Sort by the `vendor` value. */ Vendor = 'VENDOR', /** Sort by the `inventory_total` value. */ InventoryTotal = 'INVENTORY_TOTAL', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `published_at` value. */ PublishedAt = 'PUBLISHED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The possible product statuses. */ export enum ProductStatus { /** The product is ready to sell and is available to customers on the online store, sales channels, and apps. By default, existing products are set to active. */ Active = 'ACTIVE', /** The product is no longer being sold and isn't available to customers on sales channels and apps. */ Archived = 'ARCHIVED', /** The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft. */ Draft = 'DRAFT' } /** Specifies a product to unpublish from a channel and the sales channels to unpublish it from. */ export type ProductUnpublishInput = { /** The ID of the product to create or update publications for. */ id: Scalars['ID']; /** The channels to unpublish the product from. */ productPublications: Array; }; /** Return type for `productUnpublish` mutation. */ export type ProductUnpublishPayload = { __typename?: 'ProductUnpublishPayload'; /** The product that has been unpublished. */ product?: Maybe; /** The user's shop. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productUpdateMedia` mutation. */ export type ProductUpdateMediaPayload = { __typename?: 'ProductUpdateMediaPayload'; /** The updated media. */ media?: Maybe>; /** List of errors that occurred executing the mutation. */ mediaUserErrors: Array; /** The product which media was updated on. */ product?: Maybe; /** * List of errors that occurred executing the mutation. * @deprecated Use `mediaUserErrors` instead */ userErrors: Array; }; /** Return type for `productUpdate` mutation. */ export type ProductUpdatePayload = { __typename?: 'ProductUpdatePayload'; /** The updated product. */ product?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a product variant. */ export type ProductVariant = Node & HasMetafields & HasPublishedTranslations & Navigable & LegacyInteroperability & { __typename?: 'ProductVariant'; /** Whether the product variant is available for sale. */ availableForSale: Scalars['Boolean']; /** The value of the barcode associated with the product. */ barcode?: Maybe; /** The compare-at price of the variant in the default shop currency. */ compareAtPrice?: Maybe; /** The date and time when the variant was created. */ createdAt: Scalars['DateTime']; /** A default cursor that returns the single next record, sorted ascending by ID. */ defaultCursor: Scalars['String']; /** The delivery profile for the variant. */ deliveryProfile?: Maybe; /** Display name of the variant, based on product's title + variant's title. */ displayName: Scalars['String']; /** The fulfillment service associated with the product. */ fulfillmentService?: Maybe; /** Whether changes to the fulfillment service for the product variant are allowed. */ fulfillmentServiceEditable: EditableProperty; /** * The Harmonized System Code (or HS Tariff Code) for the variant. * @deprecated Use `InventoryItem.harmonizedSystemCode` instead. */ harmonizedSystemCode?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The featured image for the variant. */ image?: Maybe; /** The inventory item, which is used to query for inventory information. */ inventoryItem: InventoryItem; /** * The fulfillment service that tracks the number of items in stock for the product variant. * @deprecated Use tracked attribute on `inventoryItem` instead. */ inventoryManagement: ProductVariantInventoryManagement; /** Whether customers are allowed to place an order for the product variant when it's out of stock. */ inventoryPolicy: ProductVariantInventoryPolicy; /** The total sellable quantity of the variant. */ inventoryQuantity?: Maybe; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The media associated with the product variant. */ media: MediaConnection; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** The order of the product variant in the list of product variants. The first position in the list is 1. */ position: Scalars['Int']; /** List of prices and compare-at prices in the presentment currencies for this shop. */ presentmentPrices: ProductVariantPricePairConnection; /** The price of the product variant in the default shop currency. */ price: Scalars['Money']; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** The product that this variant belongs to. */ product: Product; /** * Whether a customer needs to provide a shipping address when placing an order for the product variant. * @deprecated Use `InventoryItem.requiresShipping` instead. */ requiresShipping: Scalars['Boolean']; /** List of product options applied to the variant. */ selectedOptions: Array; /** Count of selling plan groups associated with the product variant. */ sellingPlanGroupCount: Scalars['Int']; /** An identifier for the product variant in the shop. Required in order to connect to a fulfillment service. */ sku?: Maybe; /** The storefront ID of the product variant. */ storefrontId: Scalars['StorefrontID']; /** The tax code for the product variant. */ taxCode?: Maybe; /** Whether a tax is charged when the product variant is sold. */ taxable: Scalars['Boolean']; /** The title of the product variant. */ title: Scalars['String']; /** The translations associated with the resource. */ translations: Array; /** The date and time (ISO 8601 format) when the product variant was last modified. */ updatedAt: Scalars['DateTime']; /** The weight of the product variant in the unit system specified with weight_unit. */ weight?: Maybe; /** The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: `g`, `kg`, `oz`, `lb`. */ weightUnit: WeightUnit; }; /** Represents a product variant. */ export type ProductVariantImageArgs = { maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Represents a product variant. */ export type ProductVariantMediaArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product variant. */ export type ProductVariantMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a product variant. */ export type ProductVariantMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product variant. */ export type ProductVariantPresentmentPricesArgs = { presentmentCurrencies?: Maybe>; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product variant. */ export type ProductVariantPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents a product variant. */ export type ProductVariantPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a product variant. */ export type ProductVariantTranslationsArgs = { locale: Scalars['String']; }; /** Specifies the input fields required to append media to a single variant. */ export type ProductVariantAppendMediaInput = { /** Specifies the variant to which media will be appended. */ variantId: Scalars['ID']; /** Specifies the media to append to the variant. */ mediaIds: Array; }; /** Return type for `productVariantAppendMedia` mutation. */ export type ProductVariantAppendMediaPayload = { __typename?: 'ProductVariantAppendMediaPayload'; /** The product associated with the variants and media. */ product?: Maybe; /** The product variants that were updated. */ productVariants?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple ProductVariants. */ export type ProductVariantConnection = { __typename?: 'ProductVariantConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `productVariantCreate` mutation. */ export type ProductVariantCreatePayload = { __typename?: 'ProductVariantCreatePayload'; /** The product associated with the variant. */ product?: Maybe; /** The successfully created variant. */ productVariant?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productVariantDelete` mutation. */ export type ProductVariantDeletePayload = { __typename?: 'ProductVariantDeletePayload'; /** ID of the deleted product variant. */ deletedProductVariantId?: Maybe; /** Product of the deleted product variant. */ product?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the input fields required to detach media from a single variant. */ export type ProductVariantDetachMediaInput = { /** Specifies the variant from which media will be detached. */ variantId: Scalars['ID']; /** Specifies the media to detach from the variant. */ mediaIds: Array; }; /** Return type for `productVariantDetachMedia` mutation. */ export type ProductVariantDetachMediaPayload = { __typename?: 'ProductVariantDetachMediaPayload'; /** The product associated with the variants and media. */ product?: Maybe; /** The product variants that were updated. */ productVariants?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one ProductVariant and a cursor during pagination. */ export type ProductVariantEdge = { __typename?: 'ProductVariantEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ProductVariantEdge. */ node: ProductVariant; }; /** Specifies a product variant to create or update. */ export type ProductVariantInput = { /** The value of the barcode associated with the product. */ barcode?: Maybe; /** The compare-at price of the variant. */ compareAtPrice?: Maybe; /** The ID of the fulfillment service associated with the variant. */ fulfillmentServiceId?: Maybe; /** The Harmonized System Code (or HS Tariff Code) for the variant. */ harmonizedSystemCode?: Maybe; /** Specifies the product variant to update or create a new variant if absent. */ id?: Maybe; /** The ID of the image that's associated with the variant. */ imageId?: Maybe; /** The URL of an image to associate with the variant. This field can only be used through mutations that create product images and must match one of the URLs being created on the product. */ imageSrc?: Maybe; /** The URL of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the URLs being created on the product. This field only accepts one value. */ mediaSrc?: Maybe>; /** * The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to `shopify`. Valid values: `shopify` or the handle of a fulfillment service that has inventory management enabled. * This argument is deprecated: Use tracked attribute on `inventoryItem` instead. */ inventoryManagement?: Maybe; /** Whether customers are allowed to place an order for the product variant when it's out of stock. */ inventoryPolicy?: Maybe; /** Create only field. The inventory quantities at each location where the variant is stocked. */ inventoryQuantities?: Maybe>; /** Inventory Item associated with the variant, used for unit cost. */ inventoryItem?: Maybe; /** Additional customizable information about the product variant. */ metafields?: Maybe>; /** The private metafields to associated with this product. */ privateMetafields?: Maybe>; /** The custom properties that a shop owner uses to define product variants. */ options?: Maybe>; /** The order of the product variant in the list of product variants. The first position in the list is 1. */ position?: Maybe; /** The price of the variant. */ price?: Maybe; /** Create only required field. Specifies the product on which to create the variant. */ productId?: Maybe; /** Whether the variant requires shipping. */ requiresShipping?: Maybe; /** The SKU for the variant. */ sku?: Maybe; /** Whether the variant is taxable. */ taxable?: Maybe; /** This argument is deprecated: Variant title is not a writable field; it is generated from the selected variant options. */ title?: Maybe; /** The tax code associated with the variant. */ taxCode?: Maybe; /** The weight of the variant. */ weight?: Maybe; /** The unit of weight that's used to measure the variant. */ weightUnit?: Maybe; }; /** The method of inventory tracking for a product variant. */ export enum ProductVariantInventoryManagement { /** Shopify tracks this product variant's inventory. */ Shopify = 'SHOPIFY', /** This product variant's inventory is not tracked. */ NotManaged = 'NOT_MANAGED', /** A third-party fulfillment service tracks this product variant's inventory. */ FulfillmentService = 'FULFILLMENT_SERVICE' } /** * The inventory policy for a product variant controls whether customers can continue to buy the variant when it * is out of stock. When the value is continue, customers are able to buy the variant when it's out of stock. * When the value is deny, customers can't buy the variant when it's out of stock. */ export enum ProductVariantInventoryPolicy { /** Stop selling a product variant when it is out of stock. */ Deny = 'DENY', /** Continue selling a product variant when it is out of stock. */ Continue = 'CONTINUE' } /** Return type for `productVariantJoinSellingPlanGroups` mutation. */ export type ProductVariantJoinSellingPlanGroupsPayload = { __typename?: 'ProductVariantJoinSellingPlanGroupsPayload'; /** The product variant object. */ productVariant?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `productVariantLeaveSellingPlanGroups` mutation. */ export type ProductVariantLeaveSellingPlanGroupsPayload = { __typename?: 'ProductVariantLeaveSellingPlanGroupsPayload'; /** The product variant object. */ productVariant?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The compare-at price and price of a variant sharing a currency. */ export type ProductVariantPricePair = { __typename?: 'ProductVariantPricePair'; /** The compare-at price of the variant with associated currency. */ compareAtPrice?: Maybe; /** The price of the variant with associated currency. */ price: MoneyV2; }; /** An auto-generated type for paginating through multiple ProductVariantPricePairs. */ export type ProductVariantPricePairConnection = { __typename?: 'ProductVariantPricePairConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. */ export type ProductVariantPricePairEdge = { __typename?: 'ProductVariantPricePairEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ProductVariantPricePairEdge. */ node: ProductVariantPricePair; }; /** The set of valid sort keys for the ProductVariant query. */ export enum ProductVariantSortKeys { /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `name` value. */ Name = 'NAME', /** Sort by the `sku` value. */ Sku = 'SKU', /** Sort by the `inventory_quantity` value. */ InventoryQuantity = 'INVENTORY_QUANTITY', /** Sort by the `inventory_management` value. */ InventoryManagement = 'INVENTORY_MANAGEMENT', /** Sort by the `inventory_levels.available` value. */ InventoryLevelsAvailable = 'INVENTORY_LEVELS_AVAILABLE', /** Sort by the `inventory_policy` value. */ InventoryPolicy = 'INVENTORY_POLICY', /** Sort by the `full_title` value. */ FullTitle = 'FULL_TITLE', /** Sort by the `popular` value. */ Popular = 'POPULAR', /** Sort by the `position` value. */ Position = 'POSITION', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Return type for `productVariantUpdate` mutation. */ export type ProductVariantUpdatePayload = { __typename?: 'ProductVariantUpdatePayload'; /** The product associated with the variant. */ product?: Maybe; /** The updated variant. */ productVariant?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The set of valid sort keys for the ProfileItem query. */ export enum ProfileItemSortKeys { /** Sort by the `title` value. */ Title = 'TITLE', /** Sort by the `product_type` value. */ ProductType = 'PRODUCT_TYPE', /** Sort by the `vendor` value. */ Vendor = 'VENDOR', /** Sort by the `inventory_total` value. */ InventoryTotal = 'INVENTORY_TOTAL', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `published_at` value. */ PublishedAt = 'PUBLISHED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** A publication is a group of products and collections that is published to an app. */ export type Publication = Node & { __typename?: 'Publication'; /** The app associated with the publication. */ app: App; /** The collection publications for the list of collections published to the publication. */ collectionPublicationsV3: ResourcePublicationConnection; /** The list of collections published to the publication. */ collections: CollectionConnection; /** Whether the collection is available to the publication. */ hasCollection: Scalars['Boolean']; /** Globally unique identifier. */ id: Scalars['ID']; /** Name of the publication. */ name: Scalars['String']; /** The product publications for the list of products published to the publication. */ productPublicationsV3: ResourcePublicationConnection; /** The list of products published to the publication. */ products: ProductConnection; /** Whether or not this publication supports future publishing. */ supportsFuturePublishing: Scalars['Boolean']; }; /** A publication is a group of products and collections that is published to an app. */ export type PublicationCollectionPublicationsV3Args = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** A publication is a group of products and collections that is published to an app. */ export type PublicationCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** A publication is a group of products and collections that is published to an app. */ export type PublicationHasCollectionArgs = { id: Scalars['ID']; }; /** A publication is a group of products and collections that is published to an app. */ export type PublicationProductPublicationsV3Args = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** A publication is a group of products and collections that is published to an app. */ export type PublicationProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An auto-generated type for paginating through multiple Publications. */ export type PublicationConnection = { __typename?: 'PublicationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one Publication and a cursor during pagination. */ export type PublicationEdge = { __typename?: 'PublicationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of PublicationEdge. */ node: Publication; }; /** Specifies the input fields required to publish a resource. */ export type PublicationInput = { /** ID of the channel. This argument is deprecated: Use publicationId instead. */ channelId?: Maybe; /** ID of the publication. */ publicationId?: Maybe; /** * The date and time that the resource was published. Setting this to a date in the future will schedule * the resource to be published. Only online store channels support future publishing. */ publishDate?: Maybe; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type Publishable = { /** The number of publications a resource is published to without feedback errors. */ availablePublicationCount: Scalars['Int']; /** The number of publications a resource is published on. */ publicationCount: Scalars['Int']; /** * Check to see whether the resource is published to a given channel. * @deprecated Use `publishedOnPublication` instead */ publishedOnChannel: Scalars['Boolean']; /** * Check to see whether the resource is published to the calling app's channel. * @deprecated Use `publishedOnCurrentPublication` instead */ publishedOnCurrentChannel: Scalars['Boolean']; /** Check to see whether the resource is published to the calling app's publication. */ publishedOnCurrentPublication: Scalars['Boolean']; /** Check to see whether the resource is published to a given publication. */ publishedOnPublication: Scalars['Boolean']; /** The list of resources that are published to a publication. */ resourcePublications: ResourcePublicationConnection; /** The list of resources that are either published or staged to be published to a publication. */ resourcePublicationsV2: ResourcePublicationV2Connection; /** * The list of channels that the resource is not published to. * @deprecated Use `unpublishedPublications` instead */ unpublishedChannels: ChannelConnection; /** The list of publications that the resource is not published to. */ unpublishedPublications: PublicationConnection; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type PublishablePublicationCountArgs = { onlyPublished?: Maybe; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type PublishablePublishedOnChannelArgs = { channelId: Scalars['ID']; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type PublishablePublishedOnPublicationArgs = { publicationId: Scalars['ID']; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type PublishableResourcePublicationsArgs = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type PublishableResourcePublicationsV2Args = { onlyPublished?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type PublishableUnpublishedChannelsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a resource that can be published to a channel. * A publishable resource can be either a Product or Collection. */ export type PublishableUnpublishedPublicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Return type for `publishablePublish` mutation. */ export type PublishablePublishPayload = { __typename?: 'PublishablePublishPayload'; /** Resource that has been published. */ publishable?: Maybe; /** The user's shop. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `publishablePublishToCurrentChannel` mutation. */ export type PublishablePublishToCurrentChannelPayload = { __typename?: 'PublishablePublishToCurrentChannelPayload'; /** Resource that has been published. */ publishable?: Maybe; /** The user's shop. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `publishableUnpublish` mutation. */ export type PublishableUnpublishPayload = { __typename?: 'PublishableUnpublishPayload'; /** Resource that has been unpublished. */ publishable?: Maybe; /** The user's shop. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `publishableUnpublishToCurrentChannel` mutation. */ export type PublishableUnpublishToCurrentChannelPayload = { __typename?: 'PublishableUnpublishToCurrentChannelPayload'; /** Resource that has been unpublished. */ publishable?: Maybe; /** The user's shop. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Published translation of a field of a resource. */ export type PublishedTranslation = { __typename?: 'PublishedTranslation'; /** Translation key. */ key: Scalars['String']; /** Translation locale. */ locale: Scalars['String']; /** Translation value. */ value?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRoot = { __typename?: 'QueryRoot'; /** Lookup an App by ID or return the currently authenticated App. */ app?: Maybe; /** * Fetches app by handle. * Returns null if the app doesn't exist. */ appByHandle?: Maybe; /** * Fetches app by apiKey. * Returns null if the app doesn't exist. */ appByKey?: Maybe; /** Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App. */ appInstallation?: Maybe; /** List of app installations. */ appInstallations: AppInstallationConnection; /** * Returns an automatic discount resource by ID. * @deprecated Use `automaticDiscountNode` instead */ automaticDiscount?: Maybe; /** Returns an automatic discount resource by ID. */ automaticDiscountNode?: Maybe; /** List of automatic discounts. */ automaticDiscountNodes: DiscountAutomaticNodeConnection; /** List of the shop's automatic discount saved searches. */ automaticDiscountSavedSearches: SavedSearchConnection; /** * List of automatic discounts. * @deprecated Use `automaticDiscountNodes` instead */ automaticDiscounts: DiscountAutomaticConnection; /** List of activated carrier services and which shop locations support them. */ availableCarrierServices: Array; /** List of available locales. */ availableLocales: Array; /** Lookup a carrier service by ID. */ carrierService?: Maybe; /** * Lookup a channel by ID. * @deprecated Use `publication` instead */ channel?: Maybe; /** * List of the active sales channels. * @deprecated Use `publications` instead */ channels: ChannelConnection; /** Returns a code discount resource by ID. */ codeDiscountNode?: Maybe; /** Returns a code discount identified by its code. */ codeDiscountNodeByCode?: Maybe; /** * List of code discounts. Special fields for query params: * * status: active, expired, scheduled * * discount_type: bogo, fixed_amount, free_shipping, percentage. */ codeDiscountNodes: DiscountCodeNodeConnection; /** List of the shop's code discount saved searches. */ codeDiscountSavedSearches: SavedSearchConnection; /** Returns a Collection resource by ID. */ collection?: Maybe; /** Return a collection by its handle. */ collectionByHandle?: Maybe; /** A list of rule conditions to define how collections with rules can be created. */ collectionRulesConditions: Array; /** List of the shop's collection saved searches. */ collectionSavedSearches: SavedSearchConnection; /** List of collections. */ collections: CollectionConnection; /** Return the AppInstallation for the currently authenticated App. */ currentAppInstallation: AppInstallation; /** Returns the current app's most recent BulkOperation. */ currentBulkOperation?: Maybe; /** Returns a Customer resource by ID. */ customer?: Maybe; /** Returns a CustomerPaymentMethod resource by ID. */ customerPaymentMethod?: Maybe; /** List of the shop's customer saved searches. */ customerSavedSearches: SavedSearchConnection; /** List of customers. */ customers: CustomerConnection; /** The paginated list of deletion events. */ deletionEvents: DeletionEventConnection; /** Lookup a Delivery Profile by ID. */ deliveryProfile?: Maybe; /** List of saved delivery profiles. */ deliveryProfiles: DeliveryProfileConnection; /** The shop-wide shipping settings. */ deliverySettings?: Maybe; /** The total number of discount codes for the shop. */ discountCodeCount: Scalars['Int']; /** Returns a bulk code creation resource by ID. */ discountRedeemCodeBulkCreation?: Maybe; /** List of the shop's redeemed discount code saved searches. */ discountRedeemCodeSavedSearches: SavedSearchConnection; /** Lookup a Domain by ID. */ domain?: Maybe; /** Returns a DraftOrder resource by ID. */ draftOrder?: Maybe; /** List of the shop's draft order saved searches. */ draftOrderSavedSearches: SavedSearchConnection; /** List of saved draft orders. */ draftOrders: DraftOrderConnection; /** Returns a Fulfillment resource by ID. */ fulfillment?: Maybe; /** Returns a Fulfillment order resource by ID. */ fulfillmentOrder?: Maybe; /** Returns a FulfillmentService resource by ID. */ fulfillmentService?: Maybe; /** Returns a gift card resource by ID. */ giftCard?: Maybe; /** Returns a list of gift cards. */ giftCards: GiftCardConnection; /** The total number of gift cards issued for the shop. */ giftCardsCount: Scalars['UnsignedInt64']; /** Returns an InventoryItem resource by ID. */ inventoryItem?: Maybe; /** List of inventory items. */ inventoryItems: InventoryItemConnection; /** Returns an InventoryLevel resource by ID. */ inventoryLevel?: Maybe; /** Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes. */ job?: Maybe; /** Returns an inventory Location resource by ID. */ location?: Maybe; /** List of active locations. */ locations: LocationConnection; /** * Returns a list of all origin locations available for a delivery profile. * @deprecated Use `locationsAvailableForDeliveryProfilesConnection` instead */ locationsAvailableForDeliveryProfiles?: Maybe>; /** Returns a list of all origin locations available for a delivery profile. */ locationsAvailableForDeliveryProfilesConnection: LocationConnection; /** List of a campaign's marketing activities. */ marketingActivities: MarketingActivityConnection; /** Returns a MarketingActivity resource by ID. */ marketingActivity?: Maybe; /** Returns a MarketingEvent resource by ID. */ marketingEvent?: Maybe; /** List of marketing events. */ marketingEvents: MarketingEventConnection; /** Returns a metafield by ID. */ metafield?: Maybe; /** List of metafield namespaces and keys visible to the Storefront API. */ metafieldStorefrontVisibilities: MetafieldStorefrontVisibilityConnection; /** Returns metafield storefront visibility by ID. */ metafieldStorefrontVisibility?: Maybe; /** Returns a specific node by ID. */ node?: Maybe; /** Returns the list of nodes with the given IDs. */ nodes: Array>; /** Returns an Order resource by ID. */ order?: Maybe; /** List of the shop's order saved searches. */ orderSavedSearches: SavedSearchConnection; /** List of orders placed. */ orders: OrderConnection; /** A list of price lists. */ priceList?: Maybe; /** All price lists for a shop. */ priceLists: PriceListConnection; /** Lookup a price rule by ID. */ priceRule?: Maybe; /** List of the shop's price rule saved searches. */ priceRuleSavedSearches: SavedSearchConnection; /** List of price rules. */ priceRules: PriceRuleConnection; /** Returns a private metafield by ID. */ privateMetafield?: Maybe; /** List of private metafields. */ privateMetafields: PrivateMetafieldConnection; /** Returns a Product resource by ID. */ product?: Maybe; /** Return a product by its handle. */ productByHandle?: Maybe; /** List of the shop's product saved searches. */ productSavedSearches: SavedSearchConnection; /** Returns a ProductVariant resource by ID. */ productVariant?: Maybe; /** List of the product variants. */ productVariants: ProductVariantConnection; /** List of products. */ products: ProductConnection; /** The list of public Admin API versions, including supported, release candidate and unstable versions. */ publicApiVersions: Array; /** Lookup a publication by ID. */ publication?: Maybe; /** List of the active publications. */ publications: PublicationConnection; /** Returns a Refund resource by ID. */ refund?: Maybe; /** Lookup a script tag resource by ID. */ scriptTag?: Maybe; /** A list of script tags. */ scriptTags: ScriptTagConnection; /** Returns a Selling Plan Group resource by ID. */ sellingPlanGroup?: Maybe; /** List Selling Plan Groups. */ sellingPlanGroups: SellingPlanGroupConnection; /** Returns a Shop resource corresponding to access token used in request. */ shop: Shop; /** List of locales available on a shop. */ shopLocales: Array; /** Shopify Payments account information, including balances and payouts. */ shopifyPaymentsAccount?: Maybe; /** Returns a SubscriptionBillingAttempt by ID. */ subscriptionBillingAttempt?: Maybe; /** Returns a Subscription Contract resource by ID. */ subscriptionContract?: Maybe; /** List Subscription Contracts. */ subscriptionContracts: SubscriptionContractConnection; /** Returns a Subscription Draft resource by ID. */ subscriptionDraft?: Maybe; /** List of TenderTransactions associated with the Shop. */ tenderTransactions: TenderTransactionConnection; /** Translatable resource. */ translatableResource?: Maybe; /** List of translatable resources. */ translatableResources: TranslatableResourceConnection; /** Returns a webhook subscription by ID. */ webhookSubscription?: Maybe; /** List of webhook subscriptions. */ webhookSubscriptions: WebhookSubscriptionConnection; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAppArgs = { id?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAppByHandleArgs = { handle: Scalars['String']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAppByKeyArgs = { apiKey: Scalars['String']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAppInstallationArgs = { id?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAppInstallationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; category?: Maybe; privacy?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAutomaticDiscountArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAutomaticDiscountNodeArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAutomaticDiscountNodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAutomaticDiscountSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootAutomaticDiscountsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCarrierServiceArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootChannelArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootChannelsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCodeDiscountNodeArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCodeDiscountNodeByCodeArgs = { code: Scalars['String']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCodeDiscountNodesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCodeDiscountSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionByHandleArgs = { handle: Scalars['String']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCustomerArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCustomerPaymentMethodArgs = { id: Scalars['ID']; showRevoked?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCustomerSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCustomersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDeletionEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; subjectTypes?: Maybe>; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDeliveryProfileArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDeliveryProfilesArgs = { merchantOwnedOnly?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDiscountCodeCountArgs = { query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDiscountRedeemCodeBulkCreationArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDiscountRedeemCodeSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDomainArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDraftOrderArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDraftOrderSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootDraftOrdersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootFulfillmentArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootFulfillmentOrderArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootFulfillmentServiceArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootGiftCardArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootGiftCardsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootGiftCardsCountArgs = { enabled?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootInventoryItemArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootInventoryItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootInventoryLevelArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootJobArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootLocationArgs = { id?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootLocationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; includeLegacy?: Maybe; includeInactive?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootLocationsAvailableForDeliveryProfilesConnectionArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMarketingActivitiesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMarketingActivityArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMarketingEventArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMarketingEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetafieldArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetafieldStorefrontVisibilitiesArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetafieldStorefrontVisibilityArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodeArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodesArgs = { ids: Array; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootOrderArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootOrderSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootOrdersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPriceListArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPriceListsArgs = { matchRule?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPriceRuleArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPriceRuleSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPriceRulesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPrivateMetafieldArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPrivateMetafieldsArgs = { namespace?: Maybe; owner: Scalars['ID']; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductByHandleArgs = { handle: Scalars['String']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductVariantArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductVariantsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPublicationArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPublicationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootRefundArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootScriptTagArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootScriptTagsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; src?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSellingPlanGroupArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSellingPlanGroupsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootShopLocalesArgs = { published?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSubscriptionBillingAttemptArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSubscriptionContractArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSubscriptionContractsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSubscriptionDraftArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootTenderTransactionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootTranslatableResourceArgs = { resourceId: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootTranslatableResourcesArgs = { resourceType: TranslatableResourceType; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootWebhookSubscriptionArgs = { id: Scalars['ID']; }; /** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootWebhookSubscriptionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; callbackUrl?: Maybe; format?: Maybe; topics?: Maybe>; }; /** Represents a refund of items or transactions in an order. */ export type Refund = Node & LegacyInteroperability & { __typename?: 'Refund'; /** When the refund was created. */ createdAt?: Maybe; /** A list of the order's refunded duties. */ duties?: Maybe>; /** Globally unique identifier. */ id: Scalars['ID']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** Note associated with the refund. */ note?: Maybe; /** The order associated with the refund. */ order: Order; /** The RefundLineItem resources attached to the refund. */ refundLineItems: RefundLineItemConnection; /** * Total amount refunded across all the transactions for this refund. * @deprecated Use `totalRefundedSet` instead */ totalRefunded: MoneyV2; /** Total amount refunded across all the transactions for this refund in shop and presentment currencies. */ totalRefundedSet: MoneyBag; /** Transactions associated with the refund. */ transactions: OrderTransactionConnection; /** When the refund was last updated. */ updatedAt: Scalars['DateTime']; }; /** Represents a refund of items or transactions in an order. */ export type RefundRefundLineItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a refund of items or transactions in an order. */ export type RefundTransactionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Return type for `refundCreate` mutation. */ export type RefundCreatePayload = { __typename?: 'RefundCreatePayload'; /** The order associated with the created refund. */ order?: Maybe; /** The created refund. */ refund?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a refunded duty. */ export type RefundDuty = { __typename?: 'RefundDuty'; /** Returns the amount of a refunded duty in shop and presentment currencies. */ amountSet: MoneyBag; /** Returns a Duty resource. This represents the Duty in the non-refund context. */ originalDuty?: Maybe; }; /** Specifies the fields required to return duties on a refund. */ export type RefundDutyInput = { /** The ID of the duty in the refund. */ dutyId: Scalars['ID']; /** The type of refund for this duty. */ refundType?: Maybe; }; /** The type of refund to perform for a particular refund duty. */ export enum RefundDutyRefundType { /** The duty is proportionally refunded based on the quantity of the refunded line item. */ Proportional = 'PROPORTIONAL', /** The duty is fully refunded. */ Full = 'FULL' } /** Specifies the fields to create a refund. */ export type RefundInput = { /** The currency (in ISO format) that is used to refund the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ. */ currency?: Maybe; /** Order ID for which the refund is created. */ orderId: Scalars['ID']; /** An optional note attached to a refund. */ note?: Maybe; /** Whether to send a refund notification to the customer. */ notify?: Maybe; /** Specifies how much of the shipping cost to refund. */ shipping?: Maybe; /** A list of line items to refund. */ refundLineItems?: Maybe>; /** A list of duties to refund. */ refundDuties?: Maybe>; /** A list of transactions involved in the refund. */ transactions?: Maybe>; }; /** Represents the details about a refunded line item. */ export type RefundLineItem = { __typename?: 'RefundLineItem'; /** Returns a LineItem resource. This represents the LineItem in the non-refund context. */ lineItem: LineItem; /** The inventory restock location. */ location?: Maybe; /** * Returns the price of a refunded line item. * @deprecated Use `priceSet` instead */ price: Scalars['Money']; /** Returns the price of a refunded line item in shop and presentment currencies. */ priceSet: MoneyBag; /** Returns the quantity of a refunded line item. */ quantity: Scalars['Int']; /** Represents the type of restock for the refunded line item. */ restockType: RefundLineItemRestockType; /** Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund. */ restocked: Scalars['Boolean']; /** * Returns the subtotal price of a refunded line item. * @deprecated Use `subtotalSet` instead */ subtotal: Scalars['Money']; /** Returns the subtotal price of a refunded line item in shop and presentment currencies. */ subtotalSet: MoneyBag; /** * Returns the total tax charged on a refunded line item. * @deprecated Use `totalTaxSet` instead */ totalTax: Scalars['Money']; /** Returns the total tax charged on a refunded line item in shop and presentment currencies. */ totalTaxSet: MoneyBag; }; /** An auto-generated type for paginating through multiple RefundLineItems. */ export type RefundLineItemConnection = { __typename?: 'RefundLineItemConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one RefundLineItem and a cursor during pagination. */ export type RefundLineItemEdge = { __typename?: 'RefundLineItemEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of RefundLineItemEdge. */ node: RefundLineItem; }; /** Specifies the fields required to return line items on a refund. */ export type RefundLineItemInput = { /** The ID of the line item in the refund. */ lineItemId: Scalars['ID']; /** The quantity of the associated line item that was returned. */ quantity: Scalars['Int']; /** The type of restock for this line item. */ restockType?: Maybe; /** The intended location for restocking if `refundType` is not `NO_RESTOCK` */ locationId?: Maybe; }; /** The type of restock performed for a particular refund line item. */ export enum RefundLineItemRestockType { /** Refund line item was returned. */ Return = 'RETURN', /** Refund line item was canceled. */ Cancel = 'CANCEL', /** Refund line item was restocked, without specifically being identified as a return or cancelation. */ LegacyRestock = 'LEGACY_RESTOCK', /** Refund line item was not restocked. */ NoRestock = 'NO_RESTOCK' } /** Represents a refund session. */ export type RefundSession = { __typename?: 'RefundSession'; /** A globally unique identifier. */ id: Scalars['ID']; /** The refund status. */ status: RefundSessionStatus; }; /** Return type for `refundSessionReject` mutation. */ export type RefundSessionRejectPayload = { __typename?: 'RefundSessionRejectPayload'; /** The updated refund session. */ refundSession?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of RefundSessionReject. */ export type RefundSessionRejectUserError = DisplayableError & { __typename?: 'RefundSessionRejectUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by RefundSessionRejectUserError. */ export enum RefundSessionRejectUserErrorCode { /** Refund session not found. */ RefundSessionNotFound = 'REFUND_SESSION_NOT_FOUND' } /** Reason of the refund status. */ export type RefundSessionRejectionReasonInput = { /** The reason code. */ code: RefundSessionStatusReasonRejectionCode; /** A custom, localized message for the merchant. */ merchantMessage?: Maybe; }; /** Return type for `refundSessionResolve` mutation. */ export type RefundSessionResolvePayload = { __typename?: 'RefundSessionResolvePayload'; /** The updated refund session. */ refundSession?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of RefundSessionResolve. */ export type RefundSessionResolveUserError = DisplayableError & { __typename?: 'RefundSessionResolveUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by RefundSessionResolveUserError. */ export enum RefundSessionResolveUserErrorCode { /** Refund session not found. */ RefundSessionNotFound = 'REFUND_SESSION_NOT_FOUND' } /** Represents a refund status. */ export type RefundSessionStatus = { __typename?: 'RefundSessionStatus'; /** The refund status code. */ code: RefundSessionStatusCode; /** The refund status reason (if applicable). */ reason?: Maybe; }; /** Refund status codes. */ export enum RefundSessionStatusCode { /** Refund rejected. */ Rejected = 'REJECTED', /** Refund resolved. */ Resolved = 'RESOLVED' } /** Refund status reason. */ export type RefundSessionStatusReason = { __typename?: 'RefundSessionStatusReason'; /** The reason code. */ code: RefundSessionStatusReasonRejectionCode; /** The custom, localized message for the merchant. */ merchantMessage?: Maybe; }; /** Refund rejection reason codes. */ export enum RefundSessionStatusReasonRejectionCode { /** Refund processing failure. */ ProcessingError = 'PROCESSING_ERROR' } /** * Presents information or problems to merchants, with 1 or more actions that they can take. * They can optionally have a specific icon and be dismissed by merchants. */ export type ResourceAlert = { __typename?: 'ResourceAlert'; /** * Buttons in the alert that link to related information. * For example, _View risk assessment_. */ actions: Array; /** Details about the alert. */ content: Scalars['HTML']; /** * Unique identifier that appears when an alert is manually closed by the merchant. * Most alerts cannot be manually closed. */ dismissibleHandle?: Maybe; /** Icon that displays with the alert. */ icon?: Maybe; /** Indication of how important the alert is. */ severity: ResourceAlertSeverity; /** The name of the alert. */ title: Scalars['String']; }; /** An action associated to a resource alert. */ export type ResourceAlertAction = { __typename?: 'ResourceAlertAction'; /** Whether the action is primary or not. */ primary: Scalars['Boolean']; /** Resource for the action to show. */ show?: Maybe; /** Action title. */ title: Scalars['String']; /** Action target URL. */ url: Scalars['URL']; }; /** The available icons for resource alerts. */ export enum ResourceAlertIcon { /** A checkmark inside a circle. */ CheckmarkCircle = 'CHECKMARK_CIRCLE', /** A lowercase `i` inside a circle. */ InformationCircle = 'INFORMATION_CIRCLE' } /** The possible severity levels for a resource alert. */ export enum ResourceAlertSeverity { /** Indicates a neutral alert. */ Default = 'DEFAULT', /** Indicates an informative alert. */ Info = 'INFO', /** Indicates a warning alert. */ Warning = 'WARNING', /** Indicates a success alert. */ Success = 'SUCCESS', /** Indicates a critical alert. */ Critical = 'CRITICAL', Error = 'ERROR' } /** Represents feedback from apps about a resource, and the steps required to set up the apps on the shop. */ export type ResourceFeedback = { __typename?: 'ResourceFeedback'; /** * Feedback from an app about the steps a merchant needs to take to set up the app on their store. * @deprecated Use `details` instead */ appFeedback: Array; /** List of AppFeedback detailing issues regarding a resource. */ details: Array; /** Summary of resource feedback pertaining to the resource. */ summary: Scalars['String']; }; /** A resource limit represents the limits that the resource has. */ export type ResourceLimit = { __typename?: 'ResourceLimit'; /** Whether or not the resource is available. */ available: Scalars['Boolean']; /** Quantity available. If null the quantity available is unlimited. */ quantityAvailable?: Maybe; /** Quantity limit of the resource. If null the quantity is unlimited. */ quantityLimit?: Maybe; /** Quantity used of the resource. If null the quantity used cannot be retrieved. */ quantityUsed?: Maybe; }; /** A resource publication represents that a resource has been published to a publication. */ export type ResourcePublication = { __typename?: 'ResourcePublication'; /** * The channel the resource publication is published to. * @deprecated Use `publication` instead */ channel: Channel; /** * Whether the resource publication is published. Also returns true if the resource publication is scheduled to be published. * If false, then the resource publication is neither published nor scheduled to be published. */ isPublished: Scalars['Boolean']; /** The publication the resource publication is published to. */ publication: Publication; /** The date that the resource publication was or is going to be published to the publication. */ publishDate: Scalars['DateTime']; /** The resource published to the publication. */ publishable: Publishable; }; /** An auto-generated type for paginating through multiple ResourcePublications. */ export type ResourcePublicationConnection = { __typename?: 'ResourcePublicationConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ResourcePublication and a cursor during pagination. */ export type ResourcePublicationEdge = { __typename?: 'ResourcePublicationEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ResourcePublicationEdge. */ node: ResourcePublication; }; /** A resource publication represents that a resource either has been published or will be published to a publication. */ export type ResourcePublicationV2 = { __typename?: 'ResourcePublicationV2'; /** * Whether the resource publication is published. If true, then the resource publication is published to the publication. * If false, then the resource publication is staged to be published to the publication. */ isPublished: Scalars['Boolean']; /** The publication the resource publication is published to. */ publication: Publication; /** The date that the resource publication was or is going to be published to the publication. */ publishDate?: Maybe; /** The resource published to the publication. */ publishable: Publishable; }; /** An auto-generated type for paginating through multiple ResourcePublicationV2s. */ export type ResourcePublicationV2Connection = { __typename?: 'ResourcePublicationV2Connection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ResourcePublicationV2 and a cursor during pagination. */ export type ResourcePublicationV2Edge = { __typename?: 'ResourcePublicationV2Edge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ResourcePublicationV2Edge. */ node: ResourcePublicationV2; }; /** SEO information. */ export type Seo = { __typename?: 'SEO'; /** SEO Description. */ description?: Maybe; /** SEO Title. */ title?: Maybe; }; /** SEO information. */ export type SeoInput = { /** SEO title of the product. */ title?: Maybe; /** SEO description of the product. */ description?: Maybe; }; /** A saved search is a representation of a search query saved in the admin. */ export type SavedSearch = Node & LegacyInteroperability & { __typename?: 'SavedSearch'; /** The filters of a saved search. */ filters: Array; /** Globally unique identifier. */ id: Scalars['ID']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The name of a saved search. */ name: Scalars['String']; /** The query string of a saved search. This includes search terms and filters. */ query: Scalars['String']; /** The type of resource this saved search is searching in. */ resourceType: SearchResultType; /** The search terms of a saved search. */ searchTerms: Scalars['String']; }; /** An auto-generated type for paginating through multiple SavedSearches. */ export type SavedSearchConnection = { __typename?: 'SavedSearchConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Specifies the fields required to create a saved search. */ export type SavedSearchCreateInput = { /** The type of resource this saved search is searching in. */ resourceType: SearchResultType; /** A descriptive name of the saved search. */ name: Scalars['String']; /** The query string of a saved search. This includes search terms and filters. */ query: Scalars['String']; }; /** Return type for `savedSearchCreate` mutation. */ export type SavedSearchCreatePayload = { __typename?: 'SavedSearchCreatePayload'; /** The saved search that was created. */ savedSearch?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the fields to delete a saved search. */ export type SavedSearchDeleteInput = { /** ID of the saved search to delete. */ id: Scalars['ID']; }; /** Return type for `savedSearchDelete` mutation. */ export type SavedSearchDeletePayload = { __typename?: 'SavedSearchDeletePayload'; /** The id of the saved search that was deleted. */ deletedSavedSearchId?: Maybe; /** The shop of the saved search that was deleted. */ shop: Shop; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one SavedSearch and a cursor during pagination. */ export type SavedSearchEdge = { __typename?: 'SavedSearchEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SavedSearchEdge. */ node: SavedSearch; }; /** Specifies the fields required to update a saved search. */ export type SavedSearchUpdateInput = { /** ID of the saved search to update. */ id: Scalars['ID']; /** A descriptive name of the saved search. */ name?: Maybe; /** The query string of a saved search. This included search terms and filters. */ query?: Maybe; }; /** Return type for `savedSearchUpdate` mutation. */ export type SavedSearchUpdatePayload = { __typename?: 'SavedSearchUpdatePayload'; /** The saved search that was updated. */ savedSearch?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Script discount applications capture the intentions of a discount that * was created by a Shopify Script for an order's line item or shipping line. */ export type ScriptDiscountApplication = DiscountApplication & { __typename?: 'ScriptDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** * The description of the application as defined by the Script. * @deprecated Use `title` instead */ description: Scalars['String']; /** * An ordered index that can be used to identify the discount application and indicate the precedence * of the discount application for calculations. */ index: Scalars['Int']; /** How the discount amount is distributed on the discounted lines. */ targetSelection: DiscountApplicationTargetSelection; /** Whether the discount is applied on line items or shipping lines. */ targetType: DiscountApplicationTargetType; /** The title of the application as defined by the Script. */ title: Scalars['String']; /** The value of the discount application. */ value: PricingValue; }; /** A script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the order status page of checkout. */ export type ScriptTag = Node & LegacyInteroperability & { __typename?: 'ScriptTag'; /** * Whether the Shopify CDN can cache and serve the script tag. * If `true`, then the script will be cached and served by the CDN. * The cache expires 15 minutes after the script tag is successfully returned. * If `false`, then the script will be served as is. */ cache: Scalars['Boolean']; /** The date and time when the script tag was created. */ createdAt: Scalars['DateTime']; /** The page or pages on the online store that the script should be included. */ displayScope: ScriptTagDisplayScope; /** Globally unique identifier. */ id: Scalars['ID']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The URL to the remote script. */ src: Scalars['URL']; /** The date and time when the script tag was last updated. */ updatedAt: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple ScriptTags. */ export type ScriptTagConnection = { __typename?: 'ScriptTagConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `scriptTagCreate` mutation. */ export type ScriptTagCreatePayload = { __typename?: 'ScriptTagCreatePayload'; /** The script tag that was created. */ scriptTag?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `scriptTagDelete` mutation. */ export type ScriptTagDeletePayload = { __typename?: 'ScriptTagDeletePayload'; /** The ID of the deleted script tag. */ deletedScriptTagId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** The page or pages on the online store where the script should be included. */ export enum ScriptTagDisplayScope { /** Include the script on both the web storefront and the order status page. */ All = 'ALL', /** Include the script only on the order status page. */ OrderStatus = 'ORDER_STATUS', /** Include the script only on the web storefront. */ OnlineStore = 'ONLINE_STORE' } /** An auto-generated type which holds one ScriptTag and a cursor during pagination. */ export type ScriptTagEdge = { __typename?: 'ScriptTagEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ScriptTagEdge. */ node: ScriptTag; }; /** Specifies the input fields for a script tag. */ export type ScriptTagInput = { /** The URL of the remote script. */ src?: Maybe; /** The page or pages on the online store where the script should be included. */ displayScope?: Maybe; /** * Whether the Shopify CDN can cache and serve the script tag. * If `true`, then the script will be cached and served by the CDN. * The cache expires 15 minutes after the script tag is successfully returned. * If `false`, then the script will be served as is. */ cache?: Maybe; }; /** Return type for `scriptTagUpdate` mutation. */ export type ScriptTagUpdatePayload = { __typename?: 'ScriptTagUpdatePayload'; /** The script tag that was updated. */ scriptTag?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** A filter in a search query represented by a key value pair. */ export type SearchFilter = { __typename?: 'SearchFilter'; /** The key of the search filter. */ key: Scalars['String']; /** The value of the search filter. */ value: Scalars['String']; }; /** A list of search filters along with their specific options in value and label pair for filtering. */ export type SearchFilterOptions = { __typename?: 'SearchFilterOptions'; /** A list of options that can be use to filter product availability. */ productAvailability: Array; }; /** Represents an individual result returned from a search. */ export type SearchResult = { __typename?: 'SearchResult'; /** Returns the search result description text. */ description?: Maybe; /** Returns the Image resource presented to accompany a search result. */ image?: Maybe; /** Returns the ID of the resource returned in the search result. */ reference: Node; /** Returns the resource title. */ title: Scalars['String']; /** Returns the absolute URL to the resource in the search result. */ url: Scalars['URL']; }; /** The connection type for SearchResult. */ export type SearchResultConnection = { __typename?: 'SearchResultConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; /** * Information to aid in pagination. * @deprecated The provided information is not accurate. */ resultsAfterCount: Scalars['Int']; }; /** An auto-generated type which holds one SearchResult and a cursor during pagination. */ export type SearchResultEdge = { __typename?: 'SearchResultEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SearchResultEdge. */ node: SearchResult; }; /** Specifies the type of resources to be returned from a search. */ export enum SearchResultType { Order = 'ORDER', Customer = 'CUSTOMER', Product = 'PRODUCT', OnlineStorePage = 'ONLINE_STORE_PAGE', OnlineStoreBlog = 'ONLINE_STORE_BLOG', OnlineStoreArticle = 'ONLINE_STORE_ARTICLE', Collection = 'COLLECTION', DraftOrder = 'DRAFT_ORDER', PriceRule = 'PRICE_RULE', /** A code discount redeem code. */ DiscountRedeemCode = 'DISCOUNT_REDEEM_CODE' } /** * Properties used by customers to select a product variant. * Products can have multiple options, like different sizes or colors. */ export type SelectedOption = { __typename?: 'SelectedOption'; /** The product option’s name. */ name: Scalars['String']; /** The product option’s value. */ value: Scalars['String']; }; /** * Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups * and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing * up these records if you need to restore them later. * * For more information on selling plans, refer to * [*Creating and managing selling plans*](https://shopify.dev/tutorials/create-manage-selling-plans). */ export type SellingPlan = Node & { __typename?: 'SellingPlan'; /** Selling plan policy which describes the billing details. */ billingPolicy: SellingPlanBillingPolicy; /** The date and time when the selling plan was created. */ createdAt: Scalars['DateTime']; /** Selling plan policy which describes the delivery details. */ deliveryPolicy: SellingPlanDeliveryPolicy; /** Buyer facing string which describes the selling plan commitment. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** * A customer-facing description of the selling plan. * * If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies. */ name: Scalars['String']; /** The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ options: Array; /** Relative position of the selling plan for display. A lower position will be displayed before a higher position. */ position?: Maybe; /** Selling plan pricing details. */ pricingPolicies: Array; }; /** Represents a selling plan policy anchor. */ export type SellingPlanAnchor = { __typename?: 'SellingPlanAnchor'; /** * The day of the anchor. * * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets * the days of the week according to ISO 8601, where 1 is Monday. * * If `type` is not WEEKDAY, then the value must be between 1-31. */ day: Scalars['Int']; /** * The month of the anchor. If type is different than YEARDAY, this field must be null, otherwise it must be * between 1-12. */ month?: Maybe; /** Represents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY. */ type: SellingPlanAnchorType; }; /** Specifies the input fields required to create or update a selling plan anchor. */ export type SellingPlanAnchorInput = { /** Represents the anchor type, must be one of WEEKDAY, MONTHDAY, YEARDAY. */ type?: Maybe; /** * The day of the anchor. * * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets * the days of the week according to ISO 8601, where 1 is Monday. * * If `type` is not WEEKDAY, then the value must be between 1-31. */ day?: Maybe; /** * The month of the anchor. If type is different than YEARDAY, this field must be null, otherwise it must be * between 1-12. */ month?: Maybe; }; /** Represents the anchor type. */ export enum SellingPlanAnchorType { /** Which day of the week, between 1-7. */ Weekday = 'WEEKDAY', /** Which day of the month, between 1-31. */ Monthday = 'MONTHDAY', /** Which days of the month and year, month between 1-12, and day between 1-31. */ Yearday = 'YEARDAY' } /** * Represents the billing frequency associated to the selling plan (for example, bill every week, or bill every * three months). The selling plan billing policy and associated records (selling plan groups, selling plans, pricing * policies, and delivery policy) are deleted 48 hours after a merchant uninstalls their subscriptions app. * We recommend backing up these records if you need to restore them later. */ export type SellingPlanBillingPolicy = SellingPlanRecurringBillingPolicy; /** Specifies the input fields required to create or update a billing policy type. */ export type SellingPlanBillingPolicyInput = { /** Recurring billing policy details. */ recurring?: Maybe; }; /** An auto-generated type for paginating through multiple SellingPlans. */ export type SellingPlanConnection = { __typename?: 'SellingPlanConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** * Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver * every other week). The selling plan delivery policy and associated records (selling plan groups, selling plans, * pricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app. * We recommend backing up these records if you need to restore them later. */ export type SellingPlanDeliveryPolicy = SellingPlanRecurringDeliveryPolicy; /** Specifies the input fields to create or update a delivery policy. */ export type SellingPlanDeliveryPolicyInput = { /** Recurring delivery policy details. */ recurring?: Maybe; }; /** An auto-generated type which holds one SellingPlan and a cursor during pagination. */ export type SellingPlanEdge = { __typename?: 'SellingPlanEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SellingPlanEdge. */ node: SellingPlan; }; /** Represents a fixed selling plan pricing policy. */ export type SellingPlanFixedPricingPolicy = SellingPlanPricingPolicyBase & { __typename?: 'SellingPlanFixedPricingPolicy'; /** The price adjustment type. */ adjustmentType: SellingPlanPricingPolicyAdjustmentType; /** The price adjustment value. */ adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; /** The date and time when the fixed selling plan pricing policy was created. */ createdAt: Scalars['DateTime']; }; /** Specifies the input fields required to create or update a fixed selling plan pricing policy. */ export type SellingPlanFixedPricingPolicyInput = { /** ID of the pricing policy. */ id?: Maybe; /** Price adjustment type defined by the policy. */ adjustmentType?: Maybe; /** Price adjustment value defined by the policy. */ adjustmentValue?: Maybe; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroup = Node & { __typename?: 'SellingPlanGroup'; /** The identifier for app, exposed in Liquid and product JSON. */ appId?: Maybe; /** Whether the given product is directly associated to the selling plan group. */ appliesToProduct: Scalars['Boolean']; /** Whether the given product variant is directly associated to the selling plan group. */ appliesToProductVariant: Scalars['Boolean']; /** Whether any of the product variants of the given product are associated to the selling plan group. */ appliesToProductVariants: Scalars['Boolean']; /** The date and time when the selling plan group was created. */ createdAt: Scalars['DateTime']; /** The merchant-facing description of the selling plan group. */ description?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The merchant-facing label of the selling plan group. */ merchantCode: Scalars['String']; /** The buyer-facing label of the selling plan group. */ name: Scalars['String']; /** The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ options: Array; /** The relative position of the selling plan group for display. */ position?: Maybe; /** A count of products associated to the selling plan group. */ productCount: Scalars['Int']; /** A count of product variants associated to the selling plan group. */ productVariantCount: Scalars['Int']; /** Product variants associated to the selling plan group. */ productVariants: ProductVariantConnection; /** Products associated to the selling plan group. */ products: ProductConnection; /** Selling plans associated to the selling plan group. */ sellingPlans: SellingPlanConnection; /** A summary of the policies associated to the selling plan group. */ summary?: Maybe; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroupAppliesToProductArgs = { productId: Scalars['ID']; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroupAppliesToProductVariantArgs = { productVariantId: Scalars['ID']; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroupAppliesToProductVariantsArgs = { productId: Scalars['ID']; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroupProductVariantCountArgs = { productId?: Maybe; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroupProductVariantsArgs = { productId?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroupProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups * and associated records (selling plans and policies) are deleted 48 hours after a merchant * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */ export type SellingPlanGroupSellingPlansArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Return type for `sellingPlanGroupAddProductVariants` mutation. */ export type SellingPlanGroupAddProductVariantsPayload = { __typename?: 'SellingPlanGroupAddProductVariantsPayload'; /** The updated selling plan group. */ sellingPlanGroup?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `sellingPlanGroupAddProducts` mutation. */ export type SellingPlanGroupAddProductsPayload = { __typename?: 'SellingPlanGroupAddProductsPayload'; /** The updated selling plan group. */ sellingPlanGroup?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple SellingPlanGroups. */ export type SellingPlanGroupConnection = { __typename?: 'SellingPlanGroupConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `sellingPlanGroupCreate` mutation. */ export type SellingPlanGroupCreatePayload = { __typename?: 'SellingPlanGroupCreatePayload'; /** The created selling plan group object. */ sellingPlanGroup?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `sellingPlanGroupDelete` mutation. */ export type SellingPlanGroupDeletePayload = { __typename?: 'SellingPlanGroupDeletePayload'; /** The id of the deleted selling plan group object. */ deletedSellingPlanGroupId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. */ export type SellingPlanGroupEdge = { __typename?: 'SellingPlanGroupEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SellingPlanGroupEdge. */ node: SellingPlanGroup; }; /** Specifies the input fields required to create or update a selling plan group. */ export type SellingPlanGroupInput = { /** Buyer facing label of the selling plan group. */ name?: Maybe; /** Identifier for app, exposed in Liquid and product JSON. */ appId?: Maybe; /** Merchant facing label of the selling plan group. */ merchantCode?: Maybe; /** Merchant facing description of the selling plan group. */ description?: Maybe; /** List of selling plans to create. */ sellingPlansToCreate?: Maybe>; /** List of selling plans to update. */ sellingPlansToUpdate?: Maybe>; /** List of selling plans ids to delete. */ sellingPlansToDelete?: Maybe>; /** The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ options?: Maybe>; /** Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one. */ position?: Maybe; }; /** Return type for `sellingPlanGroupRemoveProductVariants` mutation. */ export type SellingPlanGroupRemoveProductVariantsPayload = { __typename?: 'SellingPlanGroupRemoveProductVariantsPayload'; /** The removed product variant ids. */ removedProductVariantIds?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `sellingPlanGroupRemoveProducts` mutation. */ export type SellingPlanGroupRemoveProductsPayload = { __typename?: 'SellingPlanGroupRemoveProductsPayload'; /** The removed product ids. */ removedProductIds?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies resource association with a Selling Plan Group. */ export type SellingPlanGroupResourceInput = { /** The IDs of the Variants to add to the Selling Plan Group. */ productVariantIds?: Maybe>; /** The IDs of the Products to add to the Selling Plan Group. */ productIds?: Maybe>; }; /** The set of valid sort keys for the SellingPlanGroup query. */ export enum SellingPlanGroupSortKeys { /** Sort by the `name` value. */ Name = 'NAME', /** Sort by the `updated_at` value. */ UpdatedAt = 'UPDATED_AT', /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Return type for `sellingPlanGroupUpdate` mutation. */ export type SellingPlanGroupUpdatePayload = { __typename?: 'SellingPlanGroupUpdatePayload'; /** The IDs of the deleted Subscription Plans. */ deletedSellingPlanIds?: Maybe>; /** The updated Selling Plan Group. */ sellingPlanGroup?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a selling plan group custom error. */ export type SellingPlanGroupUserError = DisplayableError & { __typename?: 'SellingPlanGroupUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Possible error codes that could be returned by SellingPlanGroupUserError. */ export enum SellingPlanGroupUserErrorCode { /** Input value is not present. */ Present = 'PRESENT', /** Input value is blank. */ Blank = 'BLANK', /** Input value is invalid. */ Invalid = 'INVALID', /** Input value should be greater than minimum allowed value. */ GreaterThan = 'GREATER_THAN', /** Input value should be greater than or equal to minimum allowed value. */ GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', /** Input value should be less than maximum allowed value. */ LessThan = 'LESS_THAN', /** Input value should be less or equal to maximum allowed value. */ LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO', /** Input value is not a number. */ NotANumber = 'NOT_A_NUMBER', /** Input value is too long. */ TooLong = 'TOO_LONG', /** Input value is too short. */ TooShort = 'TOO_SHORT', /** Input value is already taken. */ Taken = 'TAKEN', /** Exceeded the selling plan limit (20). */ SellingPlanCountUpperBound = 'SELLING_PLAN_COUNT_UPPER_BOUND', /** Must include at least one selling plan. */ SellingPlanCountLowerBound = 'SELLING_PLAN_COUNT_LOWER_BOUND', /** Selling plan's billing policy max cycles must be greater than min cycles. */ SellingPlanMaxCyclesMustBeGreaterThanMinCycles = 'SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES', /** Selling plan's billing and delivery policies anchors must be equal. */ SellingPlanBillingAndDeliveryPolicyAnchorsMustBeEqual = 'SELLING_PLAN_BILLING_AND_DELIVERY_POLICY_ANCHORS_MUST_BE_EQUAL', /** Selling plan's billing cycle must be a multiple of delivery cycle. */ SellingPlanBillingCycleMustBeAMultipleOfDeliveryCycle = 'SELLING_PLAN_BILLING_CYCLE_MUST_BE_A_MULTIPLE_OF_DELIVERY_CYCLE', /** Selling plan's pricing policies must contain one fixed pricing policy. */ SellingPlanPricingPoliciesMustContainAFixedPricingPolicy = 'SELLING_PLAN_PRICING_POLICIES_MUST_CONTAIN_A_FIXED_PRICING_POLICY', /** Cannot define option2 on this selling plan as there's no label on the parent selling plan group. */ SellingPlanMissingOption2LabelOnParentGroup = 'SELLING_PLAN_MISSING_OPTION2_LABEL_ON_PARENT_GROUP', /** Cannot define option3 on this selling plan as there's no label on the parent selling plan group. */ SellingPlanMissingOption3LabelOnParentGroup = 'SELLING_PLAN_MISSING_OPTION3_LABEL_ON_PARENT_GROUP', /** Selling plan's option2 is required because option2 exists. */ SellingPlanOption2RequiredAsDefinedOnParentGroup = 'SELLING_PLAN_OPTION2_REQUIRED_AS_DEFINED_ON_PARENT_GROUP', /** Selling plan's option3 is required because option3 exists. */ SellingPlanOption3RequiredAsDefinedOnParentGroup = 'SELLING_PLAN_OPTION3_REQUIRED_AS_DEFINED_ON_PARENT_GROUP', /** Selling plans can't have more than 2 pricing policies. */ SellingPlanPricingPoliciesLimit = 'SELLING_PLAN_PRICING_POLICIES_LIMIT', /** The selling plan list provided contains 1 or more invalid IDs. */ ResourceListContainsInvalidIds = 'RESOURCE_LIST_CONTAINS_INVALID_IDS', /** Product variant does not exist. */ ProductVariantDoesNotExist = 'PRODUCT_VARIANT_DOES_NOT_EXIST', /** Product does not exist. */ ProductDoesNotExist = 'PRODUCT_DOES_NOT_EXIST', /** Selling plan group does not exist. */ GroupDoesNotExist = 'GROUP_DOES_NOT_EXIST', /** Selling plan group could not be deleted. */ GroupCouldNotBeDeleted = 'GROUP_COULD_NOT_BE_DELETED', /** Could not add the resource to the selling plan group. */ ErrorAddingResourceToGroup = 'ERROR_ADDING_RESOURCE_TO_GROUP', /** Missing delivery policy. */ SellingPlanDeliveryPolicyMissing = 'SELLING_PLAN_DELIVERY_POLICY_MISSING', /** Missing billing policy. */ SellingPlanBillingPolicyMissing = 'SELLING_PLAN_BILLING_POLICY_MISSING', /** Selling plan does not exist. */ PlanDoesNotExist = 'PLAN_DOES_NOT_EXIST', /** Selling plan ID must be specified to update. */ PlanIdMustBeSpecifiedToUpdate = 'PLAN_ID_MUST_BE_SPECIFIED_TO_UPDATE', /** Only one pricing policy type can be defined. */ OnlyNeedOnePricingPolicyType = 'ONLY_NEED_ONE_PRICING_POLICY_TYPE', /** Only one pricing policy adjustment value type can be defined. */ OnlyNeedOnePricingPolicyValue = 'ONLY_NEED_ONE_PRICING_POLICY_VALUE', /** Pricing policy's adjustment value and adjustment type must match. */ PricingPolicyAdjustmentValueAndTypeMustMatch = 'PRICING_POLICY_ADJUSTMENT_VALUE_AND_TYPE_MUST_MATCH', /** Cannot have multiple selling plans with the same name. */ SellingPlanDuplicateName = 'SELLING_PLAN_DUPLICATE_NAME', /** Cannot have multiple selling plans with the same options. */ SellingPlanDuplicateOptions = 'SELLING_PLAN_DUPLICATE_OPTIONS' } /** Specifies the input fields to create or update a selling plan. */ export type SellingPlanInput = { /** ID of the selling plan. */ id?: Maybe; /** Buyer facing string which describes the selling plan content. */ name?: Maybe; /** Buyer facing string which describes the selling plan commitment. */ description?: Maybe; /** Selling plan policy which describes the billing details. */ billingPolicy?: Maybe; /** Selling plan policy which describes the delivery details. */ deliveryPolicy?: Maybe; /** * Pricing policies which describe the pricing details. Each selling plan * can only contain a maximum of 2 pricing policies. */ pricingPolicies?: Maybe>; /** The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ options?: Maybe>; /** Relative value for display purposes of this plan. A lower position will be displayed before a higher one. */ position?: Maybe; }; /** Represents valid selling plan interval. */ export enum SellingPlanInterval { /** Day interval. */ Day = 'DAY', /** Week interval. */ Week = 'WEEK', /** Month interval. */ Month = 'MONTH', /** Year interval. */ Year = 'YEAR' } /** * Represents the type of pricing associated to the selling plan (for example, a $10 or 20% discount that is set * for a limited period or that is fixed for the duration of the subscription). Selling plan pricing policies and * associated records (selling plan groups, selling plans, billing policy, and delivery policy) are deleted 48 * hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need * to restore them later. */ export type SellingPlanPricingPolicy = SellingPlanFixedPricingPolicy | SellingPlanRecurringPricingPolicy; /** Represents a selling plan pricing policy adjustment type. */ export enum SellingPlanPricingPolicyAdjustmentType { /** Percentage off adjustment. */ Percentage = 'PERCENTAGE', /** Fixed amount off adjustment. */ FixedAmount = 'FIXED_AMOUNT', /** Price of the policy. */ Price = 'PRICE' } /** Represents a selling plan pricing policy adjustment value type. */ export type SellingPlanPricingPolicyAdjustmentValue = MoneyV2 | SellingPlanPricingPolicyPercentageValue; /** Represents selling plan pricing policy common fields. */ export type SellingPlanPricingPolicyBase = { /** The price adjustment type. */ adjustmentType: SellingPlanPricingPolicyAdjustmentType; /** The price adjustment value. */ adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; }; /** Specifies the input fields required to create or update a selling plan pricing policy. */ export type SellingPlanPricingPolicyInput = { /** Recurring pricing policy details. */ recurring?: Maybe; /** Fixed pricing policy details. */ fixed?: Maybe; }; /** Represents the percentage value of a selling plan pricing policy percentage type. */ export type SellingPlanPricingPolicyPercentageValue = { __typename?: 'SellingPlanPricingPolicyPercentageValue'; /** The percentage value. */ percentage: Scalars['Float']; }; /** Specifies the input fields required to create or update a pricing policy adjustment value. */ export type SellingPlanPricingPolicyValueInput = { /** Defines percentage value. */ percentage?: Maybe; /** Defines fixed value for an fixed amount off or a new policy price. */ fixedValue?: Maybe; }; /** Represents a recurring selling plan billing policy. */ export type SellingPlanRecurringBillingPolicy = { __typename?: 'SellingPlanRecurringBillingPolicy'; /** Specific anchor dates upon which the billing interval calculations should be made. */ anchors: Array; /** The date and time when the selling plan billing policy was created. */ createdAt: Scalars['DateTime']; /** The billing frequency, it can be either: day, week, month or year. */ interval: SellingPlanInterval; /** The number of intervals between billings. */ intervalCount: Scalars['Int']; /** Maximum number of billing iterations. */ maxCycles?: Maybe; /** Minimum number of billing iterations. */ minCycles?: Maybe; }; /** Specifies the input fields required to create or update a recurring billing policy. */ export type SellingPlanRecurringBillingPolicyInput = { /** The billing frequency, it can be either: day, week, month or year. */ interval?: Maybe; /** The number of intervals between billings. */ intervalCount?: Maybe; /** Specific anchor dates upon which the billing interval calculations should be made. */ anchors?: Maybe>; /** Minimum number of billing iterations. */ minCycles?: Maybe; /** Maximum number of billing iterations. */ maxCycles?: Maybe; }; /** Represents a recurring selling plan delivery policy. */ export type SellingPlanRecurringDeliveryPolicy = { __typename?: 'SellingPlanRecurringDeliveryPolicy'; /** Specific anchor dates upon which the delivery interval calculations should be made. */ anchors: Array; /** The date and time when the selling plan delivery policy was created. */ createdAt: Scalars['DateTime']; /** A buffer period for orders to be included in a cycle. */ cutoff?: Maybe; /** * Specifies if the delivery policy is merchant or buyer-centric. * Buyer-centric delivery policies state the time when the buyer will receive the goods. * Merchant-centric delivery policies state the time when the fulfillment should be started. * Currently, only merchant-centric delivery policies are supported. */ intent: SellingPlanRecurringDeliveryPolicyIntent; /** The delivery frequency, it can be either: day, week, month or year. */ interval: SellingPlanInterval; /** The number of intervals between deliveries. */ intervalCount: Scalars['Int']; /** Fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`. */ preAnchorBehavior: SellingPlanRecurringDeliveryPolicyPreAnchorBehavior; }; /** Specifies the input fields to create or update a recurring delivery policy. */ export type SellingPlanRecurringDeliveryPolicyInput = { /** The delivery frequency, it can be either: day, week, month or year. */ interval?: Maybe; /** The number of intervals between deliveries. */ intervalCount?: Maybe; /** Specific anchor dates upon which the delivery interval calculations should be made. */ anchors?: Maybe>; /** A buffer period for orders to be included in a cycle. */ cutoff?: Maybe; /** Intention of this delivery policy, it can be either: delivery or fulfillment. */ intent?: Maybe; /** The pre anchor behavior. It can be either: asap or next. */ preAnchorBehavior?: Maybe; }; /** Possible intentions of a Delivery Policy. */ export enum SellingPlanRecurringDeliveryPolicyIntent { /** A merchant-centric delivery policy. Mark this delivery policy to define when the merchant should start fulfillment. */ FulfillmentBegin = 'FULFILLMENT_BEGIN' } /** Possible fulfillment or delivery behaviors of the first fulfillment when the orderis placed before the anchor. */ export enum SellingPlanRecurringDeliveryPolicyPreAnchorBehavior { /** Orders placed can be fulfilled / delivered immediately. Orders placed inside a cutoff can be fulfilled / delivered at the next anchor. */ Asap = 'ASAP', /** Orders placed can be fulfilled / delivered at the next anchor date. Ordersplaced inside a cutoff will skip the next anchor and can be fulfilled / delivered at the following anchor. */ Next = 'NEXT' } /** Represents a recurring selling plan pricing policy. */ export type SellingPlanRecurringPricingPolicy = SellingPlanPricingPolicyBase & { __typename?: 'SellingPlanRecurringPricingPolicy'; /** The price adjustment type. */ adjustmentType: SellingPlanPricingPolicyAdjustmentType; /** The price adjustment value. */ adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; /** Cycle after which this pricing policy applies. */ afterCycle?: Maybe; /** The date and time when the recurring selling plan pricing policy was created. */ createdAt: Scalars['DateTime']; }; /** Specifies the input fields required to create or update a recurring selling plan pricing policy. */ export type SellingPlanRecurringPricingPolicyInput = { /** ID of the pricing policy. */ id?: Maybe; /** Price adjustment type defined by the policy. */ adjustmentType?: Maybe; /** Price adjustment value defined by the policy. */ adjustmentValue?: Maybe; /** Cycle after which the pricing policy applies. If not provided the policy will be applicable from the first cycle. */ afterCycle: Scalars['Int']; }; /** Represents the shipping details that the customer chose for their order. */ export type ShippingLine = { __typename?: 'ShippingLine'; /** * A reference to the carrier service that provided the rate. * Present when the rate was computed by a third-party carrier service. */ carrierIdentifier?: Maybe; /** A reference to the shipping method. */ code?: Maybe; /** Whether the shipping line is custom or not. */ custom: Scalars['Boolean']; /** The general classification of the delivery method. */ deliveryCategory?: Maybe; /** The discounts that have been allocated to the shipping line. */ discountAllocations: Array; /** * The pre-tax shipping price with discounts applied. * @deprecated Use `discountedPriceSet` instead */ discountedPrice: MoneyV2; /** The pre-tax shipping price with discounts applied. */ discountedPriceSet: MoneyBag; /** Globally unique identifier. */ id?: Maybe; /** * The pre-tax shipping price without any discounts applied. * @deprecated Use `originalPriceSet` instead */ originalPrice: MoneyV2; /** The pre-tax shipping price without any discounts applied. */ originalPriceSet: MoneyBag; /** The phone number at the shipping address. */ phone?: Maybe; /** * Returns the price of the shipping line. * @deprecated Use `originalPriceSet` instead */ price: Scalars['Money']; /** * The fulfillment service requested for the shipping method. * Present if the shipping method requires processing by a third party fulfillment service. */ requestedFulfillmentService?: Maybe; /** A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. */ shippingRateHandle?: Maybe; /** Returns the rate source for the shipping line. */ source?: Maybe; /** The TaxLine objects connected to this shipping line. */ taxLines: Array; /** Returns the title of the shipping line. */ title: Scalars['String']; }; /** An auto-generated type for paginating through multiple ShippingLines. */ export type ShippingLineConnection = { __typename?: 'ShippingLineConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ShippingLine and a cursor during pagination. */ export type ShippingLineEdge = { __typename?: 'ShippingLineEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ShippingLineEdge. */ node: ShippingLine; }; /** Specifies the shipping details for the order. */ export type ShippingLineInput = { /** Price of the shipping rate. */ price?: Maybe; /** A unique identifier for the shipping rate. */ shippingRateHandle?: Maybe; /** Title of the shipping rate. */ title?: Maybe; }; /** The shipping method for the delivery. */ export type ShippingMethod = { __typename?: 'ShippingMethod'; /** A unique code associated with the rate. For example: `expedited_mail` */ code: Scalars['String']; /** * A description of the rate, which customers will see at checkout. * For example: `Includes tracking and insurance`. */ label: Scalars['String']; }; /** Return type for `shippingPackageDelete` mutation. */ export type ShippingPackageDeletePayload = { __typename?: 'ShippingPackageDeletePayload'; /** The ID of the deleted shipping package. */ deletedId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `shippingPackageMakeDefault` mutation. */ export type ShippingPackageMakeDefaultPayload = { __typename?: 'ShippingPackageMakeDefaultPayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `shippingPackageUpdate` mutation. */ export type ShippingPackageUpdatePayload = { __typename?: 'ShippingPackageUpdatePayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** A shipping rate to be applied to an order. */ export type ShippingRate = { __typename?: 'ShippingRate'; /** Human-readable unique identifier for this shipping rate. */ handle: Scalars['String']; /** Price of this shipping rate. */ price: MoneyV2; /** Title of this shipping rate. */ title: Scalars['String']; }; /** Represents the shipping costs refunded on the Refund. */ export type ShippingRefund = { __typename?: 'ShippingRefund'; /** * The monetary value of the shipping fees to be returned. * @deprecated Use `amountSet` instead */ amount: Scalars['Money']; /** The monetary value of the shipping fees to be returned in shop and presentment currencies. */ amountSet: MoneyBag; /** * The maximum amount of shipping fees currently refundable. * @deprecated Use `maximumRefundableSet` instead */ maximumRefundable: Scalars['Money']; /** The maximum amount of shipping fees currently refundable in shop and presentment currencies. */ maximumRefundableSet: MoneyBag; /** * The monetary value of the tax allocated to shipping fees to be returned. * @deprecated Use `taxSet` instead */ tax: Scalars['Money']; /** The monetary value of the tax allocated to shipping fees to be returned in shop and presentment currencies. */ taxSet: MoneyBag; }; /** Specifies the fields required to return shipping costs on a Refund. */ export type ShippingRefundInput = { /** The monetary value of the shipping fees to be returned. */ amount?: Maybe; /** Whether a full refund is provided. */ fullRefund?: Maybe; }; /** Represents the shop object. */ export type Shop = Node & HasPublishedTranslations & HasMetafields & { __typename?: 'Shop'; /** Alert message that appears in the Shopify admin. */ alerts: Array; /** The token required to query the shop's reports or dashboards. */ analyticsToken: Scalars['String']; /** Paginated list of fulfillment orders assigned to fulfillment services. */ assignedFulfillmentOrders: FulfillmentOrderConnection; /** List of sales channels not currently installed on the shop. */ availableChannelApps: AppConnection; /** The shop's billing address information. */ billingAddress: MailingAddress; /** * Exposes the number of channels. * @deprecated Use `publicationCount` instead */ channelCount: Scalars['Int']; /** * List of the shop's active sales channels. * @deprecated Use `QueryRoot.channels` instead. */ channels: ChannelConnection; /** Specifies whether the shop supports checkouts via Checkout API. */ checkoutApiSupported: Scalars['Boolean']; /** * Return a collection by its handle. * @deprecated Use `QueryRoot.collectionByHandle` instead. */ collectionByHandle?: Maybe; /** * List of the shop's collection saved searches. * @deprecated Use `QueryRoot.collectionSavedSearches` instead. */ collectionSavedSearches: SavedSearchConnection; /** * List of the shop's collections. * @deprecated Use `QueryRoot.collections` instead. */ collections: CollectionConnection; /** * The public-facing contact email address for the shop. * Customers will use this email to communicate with the shop owner. */ contactEmail: Scalars['String']; /** Countries that have been defined in shipping zones for the shop. */ countriesInShippingZones: CountriesInShippingZones; /** The three letter code for the shop's currency. */ currencyCode: CurrencyCode; /** How currencies are displayed on your store. */ currencyFormats: CurrencyFormats; /** The currency settings for the shop. */ currencySettings: CurrencySettingConnection; /** The shop's customer account requirement preference. */ customerAccounts: ShopCustomerAccountsSetting; /** * List of the shop's customer saved searches. * @deprecated Use `QueryRoot.customerSavedSearches` instead. */ customerSavedSearches: SavedSearchConnection; /** A list of tags that have been added to customer accounts. */ customerTags: StringConnection; /** * Customer accounts associated to the shop. * @deprecated Use `QueryRoot.customers` instead. */ customers: CustomerConnection; /** The shop's meta description used in search engine results. */ description?: Maybe; /** The domains configured for the shop. */ domains: Array; /** * List of the shop's draft order saved searches. * @deprecated Use `QueryRoot.draftOrderSavedSearches` instead. */ draftOrderSavedSearches: SavedSearchConnection; /** A list of tags that have been added to draft orders. */ draftOrderTags: StringConnection; /** * List of saved draft orders on the shop. * @deprecated Use `QueryRoot.draftOrders` instead. */ draftOrders: DraftOrderConnection; /** * The shop owner's email address. * Shopify will use this email address to communicate with the shop owner. */ email: Scalars['String']; /** The presentment currencies enabled for the shop. */ enabledPresentmentCurrencies: Array; /** The shop's features. */ features: ShopFeatures; /** Paginated list of merchant-managed and third-party fulfillment orders. */ fulfillmentOrders: FulfillmentOrderConnection; /** List of the shop's installed fulfillment services. */ fulfillmentServices: Array; /** The shop's time zone as defined by the IANA. */ ianaTimezone: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** * List of the shop's inventory items. * @deprecated Use `QueryRoot.inventoryItems` instead. */ inventoryItems: InventoryItemConnection; /** * The number of pendings orders on the shop. * Limited to a maximum of 10000. */ limitedPendingOrderCount: LimitedPendingOrderCount; /** * List of active locations of the shop. * @deprecated Use `QueryRoot.locations` instead. */ locations: LocationConnection; /** * List of a shop's marketing events. * @deprecated Use `QueryRoot.marketingEvents` instead. */ marketingEvents: MarketingEventConnection; /** Returns a metafield by namespace and key that belongs to the resource. */ metafield?: Maybe; /** List of metafields that belong to the resource. */ metafields: MetafieldConnection; /** The shop's .myshopify.com domain name. */ myshopifyDomain: Scalars['String']; /** The shop's name. */ name: Scalars['String']; /** The navigation settings of the shop. */ navigationSettings: Array; /** The prefix that appears before order numbers. */ orderNumberFormatPrefix: Scalars['String']; /** The suffix that appears after order numbers. */ orderNumberFormatSuffix: Scalars['String']; /** * List of the shop's order saved searches. * @deprecated Use `QueryRoot.orderSavedSearches` instead. */ orderSavedSearches: SavedSearchConnection; /** A list of tags that have been added to orders. */ orderTags: StringConnection; /** * List of orders placed on the shop. * @deprecated Use `QueryRoot.orders` instead. */ orders: OrderConnection; /** Settings related to payments. */ paymentSettings: PaymentSettings; /** * Number of pending orders on the shop. * @deprecated Use `limitedPendingOrderCount` instead */ pendingOrderCount: Scalars['Int']; /** The shop's plan. */ plan: ShopPlan; /** * List of the shop's price rule saved searches. * @deprecated Use `QueryRoot.priceRuleSavedSearches` instead. */ priceRuleSavedSearches: SavedSearchConnection; /** * List of the shop’s price rules. * @deprecated Use `QueryRoot.priceRules` instead. */ priceRules: PriceRuleConnection; /** The shop's primary domain name. */ primaryDomain: Domain; /** Returns a private metafield by namespace and key that belongs to the resource. */ privateMetafield?: Maybe; /** List of private metafields that belong to the resource. */ privateMetafields: PrivateMetafieldConnection; /** * Return a product by its handle. * @deprecated Use `QueryRoot.productByHandle` instead. */ productByHandle?: Maybe; /** All images of all products of the shop. */ productImages: ImageConnection; /** * List of the shop's product saved searches. * @deprecated Use `QueryRoot.productSavedSearches` instead. */ productSavedSearches: SavedSearchConnection; /** A list of tags that have been added to products. */ productTags: StringConnection; /** Types added to products. */ productTypes: StringConnection; /** * List of the shop's product variants. * @deprecated Use `QueryRoot.productVariants` instead. */ productVariants: ProductVariantConnection; /** Vendors added to products. */ productVendors: StringConnection; /** * List of the shop's products. * @deprecated Use `QueryRoot.products`. */ products: ProductConnection; /** Exposes the number of publications. */ publicationCount: Scalars['Int']; /** Resource limits of a shop. */ resourceLimits: ShopResourceLimits; /** The URL of the rich text editor. */ richTextEditorUrl: Scalars['URL']; /** Return admin search results. */ search: SearchResultConnection; /** List of search filter options. */ searchFilters: SearchFilterOptions; /** Whether the shop has outstanding setup steps. */ setupRequired: Scalars['Boolean']; /** Countries that the shop ships to. */ shipsToCountries: Array; /** A list of all policies associated with a shop. */ shopPolicies: Array; /** * Shopify Payments account information, including balances and payouts. * @deprecated Use `QueryRoot.shopifyPaymentsAccount` instead. */ shopifyPaymentsAccount?: Maybe; /** Storefront access token of a private application. Scoped per-application. */ storefrontAccessTokens: StorefrontAccessTokenConnection; /** * The URL of the shop's storefront. * @deprecated Use `url` instead */ storefrontUrl: Scalars['URL']; /** Specifies whether or not taxes are charged for shipping. */ taxShipping: Scalars['Boolean']; /** The setting for whether applicable taxes are included in product prices. */ taxesIncluded: Scalars['Boolean']; /** The shop's time zone abbreviation. */ timezoneAbbreviation: Scalars['String']; /** The shop's time zone offset. */ timezoneOffset: Scalars['String']; /** The shop's time zone offset expressed in number of minutes. */ timezoneOffsetMinutes: Scalars['Int']; /** The translations associated with the resource. */ translations: Array; /** The shop's unit system. */ unitSystem: UnitSystem; /** All images uploaded to the shop. */ uploadedImages: ImageConnection; /** Fetch list of images uploaded to shop by ids. */ uploadedImagesByIds: Array; /** The URL of the shop's storefront. */ url: Scalars['URL']; /** The shop's primary unit of weight for products and shipping. */ weightUnit: WeightUnit; }; /** Represents the shop object. */ export type ShopAssignedFulfillmentOrdersArgs = { assignmentStatus?: Maybe; locationIds?: Maybe>; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; }; /** Represents the shop object. */ export type ShopAvailableChannelAppsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopChannelsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopCollectionByHandleArgs = { handle: Scalars['String']; }; /** Represents the shop object. */ export type ShopCollectionSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopCollectionsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Represents the shop object. */ export type ShopCurrencySettingsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopCustomerSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopCustomerTagsArgs = { first: Scalars['Int']; }; /** Represents the shop object. */ export type ShopCustomersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopDraftOrderSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopDraftOrderTagsArgs = { first: Scalars['Int']; }; /** Represents the shop object. */ export type ShopDraftOrdersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopFulfillmentOrdersArgs = { includeClosed?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopInventoryItemsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopLocationsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; includeLegacy?: Maybe; includeInactive?: Maybe; }; /** Represents the shop object. */ export type ShopMarketingEventsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents the shop object. */ export type ShopMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopOrderSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopOrderTagsArgs = { first: Scalars['Int']; sort?: Maybe; }; /** Represents the shop object. */ export type ShopOrdersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopPriceRuleSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopPriceRulesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Represents the shop object. */ export type ShopPrivateMetafieldArgs = { namespace: Scalars['String']; key: Scalars['String']; }; /** Represents the shop object. */ export type ShopPrivateMetafieldsArgs = { namespace?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopProductByHandleArgs = { handle: Scalars['String']; }; /** Represents the shop object. */ export type ShopProductImagesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Represents the shop object. */ export type ShopProductSavedSearchesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopProductTagsArgs = { first: Scalars['Int']; }; /** Represents the shop object. */ export type ShopProductTypesArgs = { first: Scalars['Int']; }; /** Represents the shop object. */ export type ShopProductVariantsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; }; /** Represents the shop object. */ export type ShopProductVendorsArgs = { first: Scalars['Int']; }; /** Represents the shop object. */ export type ShopProductsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; query?: Maybe; savedSearchId?: Maybe; }; /** Represents the shop object. */ export type ShopSearchArgs = { query: Scalars['String']; types?: Maybe>; first: Scalars['Int']; after?: Maybe; }; /** Represents the shop object. */ export type ShopStorefrontAccessTokensArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents the shop object. */ export type ShopTranslationsArgs = { locale: Scalars['String']; }; /** Represents the shop object. */ export type ShopUploadedImagesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; sortKey?: Maybe; maxWidth?: Maybe; maxHeight?: Maybe; crop?: Maybe; scale?: Maybe; }; /** Represents the shop object. */ export type ShopUploadedImagesByIdsArgs = { imageIds: Array; }; /** Alert message that appears in the Shopify admin. */ export type ShopAlert = { __typename?: 'ShopAlert'; /** Button in the alert that links to related information. */ action: ShopAlertAction; /** Description of the alert. */ description: Scalars['String']; }; /** An action associated to a shop alert. */ export type ShopAlertAction = { __typename?: 'ShopAlertAction'; /** Action title. */ title: Scalars['String']; /** Action target URL. */ url: Scalars['URL']; }; /** * Possible branding of a shop. * Branding can be used to define the look of a shop including its styling and logo in the Shopify Admin. */ export enum ShopBranding { /** Shop has Shopify Gold branding. */ ShopifyGold = 'SHOPIFY_GOLD', /** Shop has Shopify Plus branding. */ ShopifyPlus = 'SHOPIFY_PLUS', /** Shop has Rogers branding. */ Rogers = 'ROGERS', /** Shop has Shopify branding. */ Shopify = 'SHOPIFY' } /** Represents the shop's customer account requirement preference. */ export enum ShopCustomerAccountsSetting { Required = 'REQUIRED', Optional = 'OPTIONAL', Disabled = 'DISABLED' } /** Represents the feature set available to the shop. */ export type ShopFeatures = { __typename?: 'ShopFeatures'; /** Whether a shop has access to avalara avatax. */ avalaraAvatax: Scalars['Boolean']; /** Branding of the shop. */ branding: ShopBranding; /** Whether a shop's storefront can have CAPTCHA protection. */ captcha: Scalars['Boolean']; /** Whether a shop's storefront can have CAPTCHA protection for domains not managed by Shopify. */ captchaExternalDomains: Scalars['Boolean']; /** * Whether the delivery profiles functionality is enabled for this shop. * @deprecated Delivery profiles are now 100% enabled across Shopify. */ deliveryProfiles: Scalars['Boolean']; /** Whether a shop has access to the dynamic remarketing feature. */ dynamicRemarketing: Scalars['Boolean']; /** Whether a shop can be migrated to use Shopify subscriptions. */ eligibleForSubscriptionMigration: Scalars['Boolean']; /** Whether a shop is configured properly to sell subscriptions. */ eligibleForSubscriptions: Scalars['Boolean']; /** Whether a shop can create gift cards. */ giftCards: Scalars['Boolean']; /** Display Harmonized System codes on products. Used for customs when shipping cross-border. */ harmonizedSystemCode: Scalars['Boolean']; /** Whether a shop can enable international domains. */ internationalDomains: Scalars['Boolean']; /** Whether a shop can enable international price overrides. */ internationalPriceOverrides: Scalars['Boolean']; /** Whether a shop can enable international price rules. */ internationalPriceRules: Scalars['Boolean']; /** Whether a shop has enabled a legacy subscription gateway to handle older subscriptions. */ legacySubscriptionGatewayEnabled: Scalars['Boolean']; /** Whether to show the live view. Live view is hidden from merchants that are on a trial or don't have a storefront. */ liveView: Scalars['Boolean']; /** Whether the multi-location functionality is enabled for this shop. */ multiLocation: Scalars['Boolean']; /** Whether a shop has access to the onboarding visual. */ onboardingVisual: Scalars['Boolean']; /** Whether a shop has access to all reporting features. */ reports: Scalars['Boolean']; /** Whether the shop has ever had subscription products. */ sellsSubscriptions: Scalars['Boolean']; /** * Whether the shop has a Shopify Plus subscription. * @deprecated Use Shop.plan.shopifyPlus instead. */ shopifyPlus: Scalars['Boolean']; /** Whether to show metrics. Metrics are hidden for new merchants until they become meaningful. */ showMetrics: Scalars['Boolean']; /** Whether the shop has an online storefront. */ storefront: Scalars['Boolean']; /** Whether a shop is using Shopify Balance. */ usingShopifyBalance: Scalars['Boolean']; }; /** The set of valid sort keys for the ShopImage query. */ export enum ShopImageSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** Available locale for a shop. */ export type ShopLocale = { __typename?: 'ShopLocale'; /** Locale identifier. */ locale: Scalars['String']; /** Locale name. */ name: Scalars['String']; /** Whether or not this is the default locale for the shop. */ primary: Scalars['Boolean']; /** Whether or not the locale is published. */ published: Scalars['Boolean']; }; /** Return type for `shopLocaleDisable` mutation. */ export type ShopLocaleDisablePayload = { __typename?: 'ShopLocaleDisablePayload'; /** The locale identifier that was disabled. */ locale?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `shopLocaleEnable` mutation. */ export type ShopLocaleEnablePayload = { __typename?: 'ShopLocaleEnablePayload'; /** The locale that was enabled. */ shopLocale?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the input fields for a shop locale. */ export type ShopLocaleInput = { /** Specifies the publication state of the locale. */ published?: Maybe; }; /** Return type for `shopLocaleUpdate` mutation. */ export type ShopLocaleUpdatePayload = { __typename?: 'ShopLocaleUpdatePayload'; /** The locale that was updated. */ shopLocale?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents the billing plan of the shop. */ export type ShopPlan = { __typename?: 'ShopPlan'; /** The name of the shop's billing plan. */ displayName: Scalars['String']; /** Whether the shop is a partner development shop for testing purposes. */ partnerDevelopment: Scalars['Boolean']; /** Whether the shop has a Shopify Plus subscription. */ shopifyPlus: Scalars['Boolean']; }; /** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ export type ShopPolicy = Node & HasPublishedTranslations & { __typename?: 'ShopPolicy'; /** The text of the policy. The maximum size is 512kb. */ body: Scalars['HTML']; /** Globally unique identifier. */ id: Scalars['ID']; /** The translations associated with the resource. */ translations: Array; /** The shop policy type. */ type: ShopPolicyType; /** The public URL of the policy. */ url: Scalars['URL']; }; /** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ export type ShopPolicyTranslationsArgs = { locale: Scalars['String']; }; /** Possible error codes that could be returned by ShopPolicyUserError. */ export enum ShopPolicyErrorCode { /** Input value is too big. */ TooBig = 'TOO_BIG' } /** Specifies the input fields required to update a policy. */ export type ShopPolicyInput = { /** The shop policy type. */ type: ShopPolicyType; /** Policy text, maximum size of 512kb. */ body: Scalars['String']; }; /** Available shop policy types. */ export enum ShopPolicyType { /** The refund policy. */ RefundPolicy = 'REFUND_POLICY', /** The shipping policy. */ ShippingPolicy = 'SHIPPING_POLICY', /** The privacy policy. */ PrivacyPolicy = 'PRIVACY_POLICY', /** The terms of service. */ TermsOfService = 'TERMS_OF_SERVICE', /** The terms of sale. */ TermsOfSale = 'TERMS_OF_SALE', /** The legal notice. */ LegalNotice = 'LEGAL_NOTICE', /** The subscription policy. */ SubscriptionPolicy = 'SUBSCRIPTION_POLICY' } /** Return type for `shopPolicyUpdate` mutation. */ export type ShopPolicyUpdatePayload = { __typename?: 'ShopPolicyUpdatePayload'; /** The shop policy that has been updated. */ shopPolicy?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of a shop policy mutation. */ export type ShopPolicyUserError = DisplayableError & { __typename?: 'ShopPolicyUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Resource limits of a shop. */ export type ShopResourceLimits = { __typename?: 'ShopResourceLimits'; /** Maximum number of locations allowed. */ locationLimit: Scalars['Int']; /** Maximum number of product options allowed. */ maxProductOptions: Scalars['Int']; /** The maximum number of variants allowed per product. */ maxProductVariants: Scalars['Int']; /** Whether the shop has reached the limit of the number of URL redirects it can make for resources. */ redirectLimitReached: Scalars['Boolean']; /** The maximum number of variants allowed per shop. If the shop has unlimited SKUs, then the quantity used cannot be retrieved. */ skuResourceLimits: ResourceLimit; }; /** Possible sort of tags. */ export enum ShopTagSort { /** Alphabetical sort. */ Alphabetical = 'ALPHABETICAL', /** Popularity sort. */ Popular = 'POPULAR' } /** * Balance and payout information for a * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) * account. Balance includes all balances for the currencies supported by the shop. * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. */ export type ShopifyPaymentsAccount = Node & { __typename?: 'ShopifyPaymentsAccount'; /** Whether the Shopify Payments setup is completed. */ activated: Scalars['Boolean']; /** Current balances in all currencies for the account. */ balance: Array; /** All bank accounts configured for the Shopify Payments account. */ bankAccounts: ShopifyPaymentsBankAccountConnection; /** * Statement descriptor used for charges. * * This is what buyers will see on their credit card or bank statements when making a purchase. * @deprecated Use `chargeStatementDescriptors` instead */ chargeStatementDescriptor?: Maybe; /** * Statement descriptors used for charges. * * This is what buyers will see on their credit card or bank statements when making a purchase. */ chargeStatementDescriptors?: Maybe; /** The Shopify Payments account country. */ country: Scalars['String']; /** The default payout currency for the Shopify Payments account. */ defaultCurrency: CurrencyCode; /** All disputes related to the Shopify Payments account. */ disputes: ShopifyPaymentsDisputeConnection; /** The fraud settings of the Shopify Payments account. */ fraudSettings: ShopifyPaymentsFraudSettings; /** Globally unique identifier. */ id: Scalars['ID']; /** The notifications settings for the account. */ notificationSettings: ShopifyPaymentsNotificationSettings; /** Whether the Shopify Payments account can be onboarded. */ onboardable: Scalars['Boolean']; /** Payout schedule for the account. */ payoutSchedule: ShopifyPaymentsPayoutSchedule; /** * Descriptor used for payouts. * * This is what merchants will see on their bank statement when receiving a payout. */ payoutStatementDescriptor?: Maybe; /** All current and previous payouts made between the account and the bank account. */ payouts: ShopifyPaymentsPayoutConnection; /** The permitted documents for identity verification. */ permittedVerificationDocuments: Array; /** The verifications necessary for this account. */ verifications: Array; }; /** * Balance and payout information for a * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) * account. Balance includes all balances for the currencies supported by the shop. * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. */ export type ShopifyPaymentsAccountBankAccountsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** * Balance and payout information for a * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) * account. Balance includes all balances for the currencies supported by the shop. * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. */ export type ShopifyPaymentsAccountDisputesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; query?: Maybe; }; /** * Balance and payout information for a * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) * account. Balance includes all balances for the currencies supported by the shop. * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. */ export type ShopifyPaymentsAccountPayoutsArgs = { transactionType?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** A bank account that can receive payouts. */ export type ShopifyPaymentsBankAccount = Node & { __typename?: 'ShopifyPaymentsBankAccount'; /** The account number of the bank account. */ accountNumber: Scalars['String']; /** The last digits of the account number (the rest is redacted). */ accountNumberLastDigits: Scalars['String']; /** The name of the bank. */ bankName?: Maybe; /** The country of the bank. */ country: CountryCode; /** The date that the bank account was created. */ createdAt: Scalars['DateTime']; /** The currency of the bank account. */ currency: CurrencyCode; /** Globally unique identifier. */ id: Scalars['ID']; /** All current and previous payouts made between the account and the bank account. */ payouts: ShopifyPaymentsPayoutConnection; /** The routing number of the bank account. */ routingNumber: Scalars['String']; /** The status of the bank account. */ status: ShopifyPaymentsBankAccountStatus; }; /** A bank account that can receive payouts. */ export type ShopifyPaymentsBankAccountPayoutsArgs = { transactionType?: Maybe; first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An auto-generated type for paginating through multiple ShopifyPaymentsBankAccounts. */ export type ShopifyPaymentsBankAccountConnection = { __typename?: 'ShopifyPaymentsBankAccountConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ShopifyPaymentsBankAccount and a cursor during pagination. */ export type ShopifyPaymentsBankAccountEdge = { __typename?: 'ShopifyPaymentsBankAccountEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ShopifyPaymentsBankAccountEdge. */ node: ShopifyPaymentsBankAccount; }; /** The bank account status. */ export enum ShopifyPaymentsBankAccountStatus { /** A bank account that hasn't had any activity and that's not validated. */ New = 'NEW', /** It was determined that the bank account exists. */ Validated = 'VALIDATED', /** Bank account validation was successful. */ Verified = 'VERIFIED', /** A payout to the bank account failed. */ Errored = 'ERRORED' } /** The charge descriptors for a payments account. */ export type ShopifyPaymentsChargeStatementDescriptor = { /** The default charge statement descriptor. */ default?: Maybe; /** The prefix of the statement descriptor. */ prefix: Scalars['String']; }; /** The charge descriptors for a payments account. */ export type ShopifyPaymentsDefaultChargeStatementDescriptor = ShopifyPaymentsChargeStatementDescriptor & { __typename?: 'ShopifyPaymentsDefaultChargeStatementDescriptor'; /** The default charge statement descriptor. */ default?: Maybe; /** The prefix of the statement descriptor. */ prefix: Scalars['String']; }; /** A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution. */ export type ShopifyPaymentsDispute = LegacyInteroperability & Node & { __typename?: 'ShopifyPaymentsDispute'; /** The total amount disputed by the cardholder. */ amount: MoneyV2; /** The deadline for evidence submission. */ evidenceDueBy?: Maybe; /** The date when evidence was sent. Returns null if evidence has not yet been sent. */ evidenceSentOn?: Maybe; /** The date when this dispute was resolved. Returns null if the dispute is not yet resolved. */ finalizedOn?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** The date when this dispute was initiated. */ initiatedAt: Scalars['DateTime']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The order that contains the charge that is under dispute. */ order?: Maybe; /** The reason of the dispute. */ reasonDetails: ShopifyPaymentsDisputeReasonDetails; /** The current state of the dispute. */ status: DisputeStatus; /** Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. */ type: DisputeType; }; /** An auto-generated type for paginating through multiple ShopifyPaymentsDisputes. */ export type ShopifyPaymentsDisputeConnection = { __typename?: 'ShopifyPaymentsDisputeConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination. */ export type ShopifyPaymentsDisputeEdge = { __typename?: 'ShopifyPaymentsDisputeEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ShopifyPaymentsDisputeEdge. */ node: ShopifyPaymentsDispute; }; /** The reason for the dispute provided by the cardholder's bank. */ export enum ShopifyPaymentsDisputeReason { /** The cardholder claims that they didn’t authorize the payment. */ Fraudulent = 'FRAUDULENT', /** The dispute is uncategorized, so you should contact the customer for additional details to find out why the payment was disputed. */ General = 'GENERAL', /** The customer doesn’t recognize the payment appearing on their card statement. */ Unrecognized = 'UNRECOGNIZED', /** The customer claims they were charged multiple times for the same product or service. */ Duplicate = 'DUPLICATE', /** The customer claims that you continued to charge them after a subscription was canceled. */ SubscriptionCancelled = 'SUBSCRIPTION_CANCELLED', /** The product or service was received but was defective, damaged, or not as described. */ ProductUnacceptable = 'PRODUCT_UNACCEPTABLE', /** The customer claims they did not receive the products or services purchased. */ ProductNotReceived = 'PRODUCT_NOT_RECEIVED', /** The customer claims that the purchased product was returned or the transaction was otherwise canceled, but you have not yet provided a refund or credit. */ CreditNotProcessed = 'CREDIT_NOT_PROCESSED', /** The customer account associated with the purchase is incorrect. */ IncorrectAccountDetails = 'INCORRECT_ACCOUNT_DETAILS', /** The customer's bank account has insufficient funds. */ InsufficientFunds = 'INSUFFICIENT_FUNDS', /** The customer's bank cannot process the charge. */ BankCannotProcess = 'BANK_CANNOT_PROCESS', /** The customer's bank cannot proceed with the debit since it has not been authorized. */ DebitNotAuthorized = 'DEBIT_NOT_AUTHORIZED', /** The customer initiated the dispute, so you should contact the customer for additional details to find out why the payment was disputed. */ CustomerInitiated = 'CUSTOMER_INITIATED' } /** Details regarding a dispute reason. */ export type ShopifyPaymentsDisputeReasonDetails = { __typename?: 'ShopifyPaymentsDisputeReasonDetails'; /** The raw code provided by the payment network. */ networkReasonCode?: Maybe; /** The reason for the dispute provided by the cardholder's banks. */ reason: ShopifyPaymentsDisputeReason; }; /** Presents all Shopify Payments information related to an extended authorization. */ export type ShopifyPaymentsExtendedAuthorization = { __typename?: 'ShopifyPaymentsExtendedAuthorization'; /** The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. */ extendedAuthorizationExpiresAt: Scalars['DateTime']; /** The time after which capture will incur an additional fee. */ standardAuthorizationExpiresAt: Scalars['DateTime']; }; /** The fraud settings of a payments account. */ export type ShopifyPaymentsFraudSettings = { __typename?: 'ShopifyPaymentsFraudSettings'; /** Decline a charge if there is an AVS failure. */ declineChargeOnAvsFailure: Scalars['Boolean']; /** Decline a charge if there is an CVC failure. */ declineChargeOnCvcFailure: Scalars['Boolean']; }; /** The charge descriptors for a Japanese payments account. */ export type ShopifyPaymentsJpChargeStatementDescriptor = ShopifyPaymentsChargeStatementDescriptor & { __typename?: 'ShopifyPaymentsJpChargeStatementDescriptor'; /** The default charge statement descriptor. */ default?: Maybe; /** The charge statement descriptor in kana. */ kana?: Maybe; /** The charge statement descriptor in kanji. */ kanji?: Maybe; /** The prefix of the statement descriptor. */ prefix: Scalars['String']; }; /** The notification settings for the account. */ export type ShopifyPaymentsNotificationSettings = { __typename?: 'ShopifyPaymentsNotificationSettings'; /** Receive email notifications when new payouts are sent or payouts fail. */ payouts: Scalars['Boolean']; }; /** * Payouts represent the movement of money between a merchant's Shopify * Payments balance and their bank account. */ export type ShopifyPaymentsPayout = LegacyInteroperability & Node & { __typename?: 'ShopifyPaymentsPayout'; /** The bank account for the payout. */ bankAccount?: Maybe; /** * The total amount and currency of the payout. * @deprecated Use `net` instead */ gross: MoneyV2; /** Globally unique identifier. */ id: Scalars['ID']; /** * The exact time when the payout was issued. The payout only contains * balance transactions that were available at this time. */ issuedAt: Scalars['DateTime']; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The total amount and currency of the payout. */ net: MoneyV2; /** The transfer status of the payout. */ status: ShopifyPaymentsPayoutStatus; /** The summary of the payout. */ summary: ShopifyPaymentsPayoutSummary; /** The direction of the payout. */ transactionType: ShopifyPaymentsPayoutTransactionType; }; /** An auto-generated type for paginating through multiple ShopifyPaymentsPayouts. */ export type ShopifyPaymentsPayoutConnection = { __typename?: 'ShopifyPaymentsPayoutConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination. */ export type ShopifyPaymentsPayoutEdge = { __typename?: 'ShopifyPaymentsPayoutEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of ShopifyPaymentsPayoutEdge. */ node: ShopifyPaymentsPayout; }; /** The interval at which payouts are sent to the connected bank account. */ export enum ShopifyPaymentsPayoutInterval { /** Each business day. */ Daily = 'DAILY', /** Each week, on the day of week specified by weeklyAnchor. */ Weekly = 'WEEKLY', /** Each month, on the day of month specified by monthlyAnchor. */ Monthly = 'MONTHLY', /** Payouts will not be automatically made. */ Manual = 'MANUAL' } /** The payment schedule for a payments account. */ export type ShopifyPaymentsPayoutSchedule = { __typename?: 'ShopifyPaymentsPayoutSchedule'; /** The interval at which payouts are sent to the connected bank account. */ interval: ShopifyPaymentsPayoutInterval; /** * The day of the month funds will be paid out. * * The value can be any day of the month from the 1st to the 31st. * If the payment interval is set to monthly, this value will be used. * Payouts scheduled between 29-31st of the month are sent on the last day of shorter months. */ monthlyAnchor?: Maybe; /** * The day of the week funds will be paid out. * * The value can be any weekday from Monday to Friday. * If the payment interval is set to weekly, this value will be used. */ weeklyAnchor?: Maybe; }; /** The transfer status of the payout. */ export enum ShopifyPaymentsPayoutStatus { /** * The payout has been created and had transactions assigned to it, but * it has not yet been submitted to the bank. */ Scheduled = 'SCHEDULED', /** The payout has been submitted to the bank. */ InTransit = 'IN_TRANSIT', /** The payout has been successfully deposited into the bank. */ Paid = 'PAID', /** The payout has been declined by the bank. */ Failed = 'FAILED', /** The payout has been canceled by Shopify. */ Canceled = 'CANCELED' } /** * Breakdown of the total fees and gross of each of the different types of transactions associated * with the payout. */ export type ShopifyPaymentsPayoutSummary = { __typename?: 'ShopifyPaymentsPayoutSummary'; /** Total fees for all adjustments including disputes. */ adjustmentsFee: MoneyV2; /** Total gross amount for all adjustments including disputes. */ adjustmentsGross: MoneyV2; /** Total fees for all charges. */ chargesFee: MoneyV2; /** Total gross amount for all charges. */ chargesGross: MoneyV2; /** Total fees for all refunds. */ refundsFee: MoneyV2; /** Total gross amount for all refunds. */ refundsFeeGross: MoneyV2; /** Total fees for all reserved funds. */ reservedFundsFee: MoneyV2; /** Total gross amount for all reserved funds. */ reservedFundsGross: MoneyV2; /** Total fees for all retried payouts. */ retriedPayoutsFee: MoneyV2; /** Total gross amount for all retried payouts. */ retriedPayoutsGross: MoneyV2; }; /** The possible transaction types for a payout. */ export enum ShopifyPaymentsPayoutTransactionType { /** The payout is a deposit. */ Deposit = 'DEPOSIT', /** The payout is a withdrawal. */ Withdrawal = 'WITHDRAWAL' } /** Presents all Shopify Payments specific information related to an order transaction. */ export type ShopifyPaymentsTransactionSet = { __typename?: 'ShopifyPaymentsTransactionSet'; /** Contains all fields related to an extended authorization. */ extendedAuthorizationSet?: Maybe; }; /** * Each subject (individual) of an account has a verification object giving * information about the verification state. */ export type ShopifyPaymentsVerification = Node & { __typename?: 'ShopifyPaymentsVerification'; /** Globally unique identifier. */ id: Scalars['ID']; /** The status of the verification. */ status: ShopifyPaymentsVerificationStatus; /** The subject/individual who has to be verified. */ subject: ShopifyPaymentsVerificationSubject; }; /** A document which can be used to verify an individual. */ export type ShopifyPaymentsVerificationDocument = { __typename?: 'ShopifyPaymentsVerificationDocument'; /** True if the back side of the document is required. */ backRequired: Scalars['Boolean']; /** True if the front side of the document is required. */ frontRequired: Scalars['Boolean']; /** The type of the document which can be used for verification. */ type: ShopifyPaymentsVerificationDocumentType; }; /** The types of possible verification documents. */ export enum ShopifyPaymentsVerificationDocumentType { /** The subject's driver's license. */ DriversLicense = 'DRIVERS_LICENSE', /** A government's identification document of the subject. */ GovernmentIdentification = 'GOVERNMENT_IDENTIFICATION', /** The subject's passport. */ Passport = 'PASSPORT' } /** The status of a verification. */ export enum ShopifyPaymentsVerificationStatus { /** The verification has been verified. */ Verified = 'VERIFIED', /** The verification has not yet been verified. */ Unverified = 'UNVERIFIED', /** The verification request has been submitted but a response has not yet been given. */ Pending = 'PENDING' } /** The verification subject represents an individual that has to be verified. */ export type ShopifyPaymentsVerificationSubject = { __typename?: 'ShopifyPaymentsVerificationSubject'; /** The family name of the individual to verify. */ familyName: Scalars['String']; /** The given name of the individual to verify. */ givenName: Scalars['String']; }; /** Image to be uploaded. */ export type StageImageInput = { /** Image resource. */ resource: StagedUploadTargetGenerateUploadResource; /** Image filename. */ filename: Scalars['String']; /** Image MIME type. */ mimeType: Scalars['String']; /** HTTP method to be used by the Staged Upload. */ httpMethod?: Maybe; }; /** Staged media target information. */ export type StagedMediaUploadTarget = { __typename?: 'StagedMediaUploadTarget'; /** Parameters of the media to be uploaded. */ parameters: Array; /** The url to be passed as the original_source for the product create media mutation input. */ resourceUrl?: Maybe; /** Media URL. */ url?: Maybe; }; /** Possible HTTP method of a staged upload target. */ export enum StagedUploadHttpMethodType { /** The POST HTTP method. */ Post = 'POST', /** The PUT HTTP method. */ Put = 'PUT' } /** Media to be uploaded. */ export type StagedUploadInput = { /** Media resource. */ resource: StagedUploadTargetGenerateUploadResource; /** Media filename. */ filename: Scalars['String']; /** Media MIME type. */ mimeType: Scalars['String']; /** HTTP method to be used by the Staged Upload. */ httpMethod?: Maybe; /** Size of the file to upload, in bytes. This is required for VIDEO and MODEL_3D resources. */ fileSize?: Maybe; }; /** Upload parameter of a Media. */ export type StagedUploadParameter = { __typename?: 'StagedUploadParameter'; /** Parameter name. */ name: Scalars['String']; /** Parameter value. */ value: Scalars['String']; }; /** Staged target information. */ export type StagedUploadTarget = { __typename?: 'StagedUploadTarget'; /** Parameters of an image to be uploaded. */ parameters: Array; /** Image URL. */ url: Scalars['String']; }; /** Specifies the fields required to generate the URL and parameters needed to upload an asset to Shopify. */ export type StagedUploadTargetGenerateInput = { /** The resource type being uploaded. */ resource: StagedUploadTargetGenerateUploadResource; /** The filename of the asset being uploaded. */ filename: Scalars['String']; /** The MIME type of the asset being uploaded. */ mimeType: Scalars['String']; /** The HTTP method to be used by the staged upload. */ httpMethod?: Maybe; /** The size of the file to upload, in bytes. */ fileSize?: Maybe; }; /** Return type for `stagedUploadTargetGenerate` mutation. */ export type StagedUploadTargetGeneratePayload = { __typename?: 'StagedUploadTargetGeneratePayload'; /** The signed parameters that can be used to upload the asset. */ parameters: Array; /** The signed URL where the asset can be uploaded. */ url: Scalars['String']; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the resource type to receive. */ export enum StagedUploadTargetGenerateUploadResource { /** A timeline event. */ Timeline = 'TIMELINE', /** A product image. */ ProductImage = 'PRODUCT_IMAGE', /** A collection image. */ CollectionImage = 'COLLECTION_IMAGE', /** A shop image. */ ShopImage = 'SHOP_IMAGE', /** Merchandising::Image resource representation. */ Image = 'IMAGE', /** Merchandising::Model3d resource representation. */ Model_3D = 'MODEL_3D', /** Merchandising::Video resource representation. */ Video = 'VIDEO' } /** Return type for `stagedUploadTargetsGenerate` mutation. */ export type StagedUploadTargetsGeneratePayload = { __typename?: 'StagedUploadTargetsGeneratePayload'; /** The staged upload targets that were generated. */ urls?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `stagedUploadsCreate` mutation. */ export type StagedUploadsCreatePayload = { __typename?: 'StagedUploadsCreatePayload'; /** The staged upload targets that were generated. */ stagedTargets?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Token used to delegate unauthenticated access scopes to clients that need to access the unautheticated Storefront API. */ export type StorefrontAccessToken = Node & { __typename?: 'StorefrontAccessToken'; /** List of permissions associated with the token. */ accessScopes: Array; /** The issued public access token. */ accessToken: Scalars['String']; /** The date and time when the public access token was created. */ createdAt: Scalars['DateTime']; /** Globally unique identifier. */ id: Scalars['ID']; /** An arbitrary title for each token determined by the developer, used for reference purposes. */ title: Scalars['String']; /** The date and time when the storefront access token was updated. */ updatedAt: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple StorefrontAccessTokens. */ export type StorefrontAccessTokenConnection = { __typename?: 'StorefrontAccessTokenConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `storefrontAccessTokenCreate` mutation. */ export type StorefrontAccessTokenCreatePayload = { __typename?: 'StorefrontAccessTokenCreatePayload'; /** The user's shop. */ shop: Shop; /** The storefront access token. */ storefrontAccessToken?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the input fields to delete a storefront access token. */ export type StorefrontAccessTokenDeleteInput = { /** The ID of the storefront access token to delete. */ id: Scalars['ID']; }; /** Return type for `storefrontAccessTokenDelete` mutation. */ export type StorefrontAccessTokenDeletePayload = { __typename?: 'StorefrontAccessTokenDeletePayload'; /** The ID of the deleted storefront access token. */ deletedStorefrontAccessTokenId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one StorefrontAccessToken and a cursor during pagination. */ export type StorefrontAccessTokenEdge = { __typename?: 'StorefrontAccessTokenEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of StorefrontAccessTokenEdge. */ node: StorefrontAccessToken; }; /** Specifies the input fields for a storefront access token. */ export type StorefrontAccessTokenInput = { /** A title for the storefront access token. */ title: Scalars['String']; }; /** An auto-generated type for paginating through multiple Strings. */ export type StringConnection = { __typename?: 'StringConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one String and a cursor during pagination. */ export type StringEdge = { __typename?: 'StringEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of StringEdge. */ node: Scalars['String']; }; /** Represents an applied code discount. */ export type SubscriptionAppliedCodeDiscount = { __typename?: 'SubscriptionAppliedCodeDiscount'; /** The unique identifier. */ id: Scalars['ID']; /** The redeem code of the discount that applies on the subscription. */ redeemCode: Scalars['String']; /** The reason that the discount on the subscription draft is rejected. */ rejectionReason?: Maybe; }; /** Record of an execution of the subscription billing schedule. */ export type SubscriptionBillingAttempt = Node & { __typename?: 'SubscriptionBillingAttempt'; /** The date and time when the billing attempt was completed. */ completedAt?: Maybe; /** The date and time when the billing attempt was created. */ createdAt: Scalars['DateTime']; /** A code corresponding to a payment error during processing. */ errorCode?: Maybe; /** A message describing a payment error during processing. */ errorMessage?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** A unique key generated by the client to avoid duplicate payments. */ idempotencyKey: Scalars['String']; /** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */ nextActionUrl?: Maybe; /** The result of this billing attempt if completed successfully. */ order?: Maybe; /** Whether or not the billing attempt is still processing. */ ready: Scalars['Boolean']; /** The subscription contract. */ subscriptionContract: SubscriptionContract; }; /** An auto-generated type for paginating through multiple SubscriptionBillingAttempts. */ export type SubscriptionBillingAttemptConnection = { __typename?: 'SubscriptionBillingAttemptConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `subscriptionBillingAttemptCreate` mutation. */ export type SubscriptionBillingAttemptCreatePayload = { __typename?: 'SubscriptionBillingAttemptCreatePayload'; /** The subscription billing attempt. */ subscriptionBillingAttempt?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination. */ export type SubscriptionBillingAttemptEdge = { __typename?: 'SubscriptionBillingAttemptEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SubscriptionBillingAttemptEdge. */ node: SubscriptionBillingAttempt; }; /** * The possible error codes associated with making billing attempts. The error codes supplement the * `error_message` to provide consistent results and help with dunning management. */ export enum SubscriptionBillingAttemptErrorCode { /** Payment method was not found. */ PaymentMethodNotFound = 'PAYMENT_METHOD_NOT_FOUND', /** Payment provider is not enabled. */ PaymentProviderIsNotEnabled = 'PAYMENT_PROVIDER_IS_NOT_ENABLED', /** Payment method is invalid. Please update or create a new payment method. */ InvalidPaymentMethod = 'INVALID_PAYMENT_METHOD', /** There was an unexpected error during the billing attempt. */ UnexpectedError = 'UNEXPECTED_ERROR', /** Payment method is expired. */ ExpiredPaymentMethod = 'EXPIRED_PAYMENT_METHOD', /** Payment method was declined by processor. */ PaymentMethodDeclined = 'PAYMENT_METHOD_DECLINED', /** There was an error during the authentication. */ AuthenticationError = 'AUTHENTICATION_ERROR', /** Gateway is in test mode and attempted to bill a live payment method. */ TestMode = 'TEST_MODE' } /** Specifies the fields required to complete a subscription billing attempt. */ export type SubscriptionBillingAttemptInput = { /** A unique key generated by the client to avoid duplicate payments. For more information, refer to [Idempotent requests](https://shopify.dev/concepts/about-apis/idempotent-requests). */ idempotencyKey: Scalars['String']; }; /** Represents a Subscription Billing Policy. */ export type SubscriptionBillingPolicy = { __typename?: 'SubscriptionBillingPolicy'; /** Specific anchor dates upon which the billing interval calculations should be made. */ anchors: Array; /** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */ interval: SellingPlanInterval; /** The number of billing intervals between invoices. */ intervalCount: Scalars['Int']; /** Maximum amount of cycles after which the subscription ends. */ maxCycles?: Maybe; /** Minimum amount of cycles required in the subscription. */ minCycles?: Maybe; }; /** Specifies the input fields for a Subscription Billing Policy. */ export type SubscriptionBillingPolicyInput = { /** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */ interval: SellingPlanInterval; /** The number of billing intervals between invoices. */ intervalCount: Scalars['Int']; /** Minimum amount of cycles required in the subscription. */ minCycles?: Maybe; /** Maximum amount of cycles required in the subscription. */ maxCycles?: Maybe; /** Specific anchor dates upon which the billing interval calculations should be made. */ anchors?: Maybe>; }; /** Represents a Subscription Contract. */ export type SubscriptionContract = Node & { __typename?: 'SubscriptionContract'; /** The subscription app that this subscription contract is registered to. */ app?: Maybe; /** URL of the subscription contract page on the subscription app. */ appAdminUrl?: Maybe; /** The list of billing attempts associated with the subscription contract. */ billingAttempts: SubscriptionBillingAttemptConnection; /** The billing policy associated with the subscription contract. */ billingPolicy: SubscriptionBillingPolicy; /** The date and time when the subscription contract was created. */ createdAt: Scalars['DateTime']; /** The currency used for the subscription contract. */ currencyCode: CurrencyCode; /** The customer to whom the subscription contract belongs. */ customer?: Maybe; /** The customer payment method used for the subscription contract. */ customerPaymentMethod?: Maybe; /** The delivery method for each billing of the subscription contract. */ deliveryMethod?: Maybe; /** The delivery policy associated with the subscription contract. */ deliveryPolicy: SubscriptionDeliveryPolicy; /** The delivery price for each billing of the subscription contract. */ deliveryPrice: MoneyV2; /** The list of subscription discounts associated with the subscription contract. */ discounts: SubscriptionManualDiscountConnection; /** Globally unique identifier. */ id: Scalars['ID']; /** The current status of the last payment. */ lastPaymentStatus?: Maybe; /** The number of lines associated with the subscription contract. */ lineCount: Scalars['Int']; /** The list of subscription lines associated with the subscription contract. */ lines: SubscriptionLineConnection; /** The next billing date for the subscription contract. */ nextBillingDate?: Maybe; /** The list of orders associated with the subscription contract. */ orders: OrderConnection; /** The order from which this contract originated. */ originOrder?: Maybe; /** The current status of the subscription contract. */ status: SubscriptionContractSubscriptionStatus; /** The date and time when the subscription contract was updated. */ updatedAt: Scalars['DateTime']; }; /** Represents a Subscription Contract. */ export type SubscriptionContractBillingAttemptsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Contract. */ export type SubscriptionContractCustomerPaymentMethodArgs = { showRevoked?: Maybe; }; /** Represents a Subscription Contract. */ export type SubscriptionContractDiscountsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Contract. */ export type SubscriptionContractLinesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Contract. */ export type SubscriptionContractOrdersArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** An auto-generated type for paginating through multiple SubscriptionContracts. */ export type SubscriptionContractConnection = { __typename?: 'SubscriptionContractConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Specifies the input fields required to create a Subscription Contract. */ export type SubscriptionContractCreateInput = { /** The ID of the customer to associate with the subscription contract. */ customerId: Scalars['ID']; /** The next billing date for the subscription contract. */ nextBillingDate: Scalars['DateTime']; /** The currency used for the subscription contract. */ currencyCode: CurrencyCode; /** The attributes used as input for the Subscription Draft. */ contract: SubscriptionDraftInput; }; /** Return type for `subscriptionContractCreate` mutation. */ export type SubscriptionContractCreatePayload = { __typename?: 'SubscriptionContractCreatePayload'; /** The Subscription Contract object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one SubscriptionContract and a cursor during pagination. */ export type SubscriptionContractEdge = { __typename?: 'SubscriptionContractEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SubscriptionContractEdge. */ node: SubscriptionContract; }; /** Possible error codes that could be returned by SubscriptionContractUserError. */ export enum SubscriptionContractErrorCode { /** Input value is invalid. */ Invalid = 'INVALID' } /** Possible status values of the last payment on a subscription contract. */ export enum SubscriptionContractLastPaymentStatus { /** Successful subscription billing attempt. */ Succeeded = 'SUCCEEDED', /** Failed subscription billing attempt. */ Failed = 'FAILED' } /** Return type for `subscriptionContractSetNextBillingDate` mutation. */ export type SubscriptionContractSetNextBillingDatePayload = { __typename?: 'SubscriptionContractSetNextBillingDatePayload'; /** The updated Subscription Contract object. */ contract?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Possible status values of a subscription. */ export enum SubscriptionContractSubscriptionStatus { /** Active subscription contract. */ Active = 'ACTIVE', /** Paused subscription contract. */ Paused = 'PAUSED', /** Cancelled subscription contract. */ Cancelled = 'CANCELLED', /** Expired subscription contract. */ Expired = 'EXPIRED', /** Failed subscription contract. */ Failed = 'FAILED' } /** Return type for `subscriptionContractUpdate` mutation. */ export type SubscriptionContractUpdatePayload = { __typename?: 'SubscriptionContractUpdatePayload'; /** The Subscription Contract object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a Subscription Contract error. */ export type SubscriptionContractUserError = DisplayableError & { __typename?: 'SubscriptionContractUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Represents a Subscription Line Pricing Cycle Adjustment. */ export type SubscriptionCyclePriceAdjustment = { __typename?: 'SubscriptionCyclePriceAdjustment'; /** Price adjustment type. */ adjustmentType: SellingPlanPricingPolicyAdjustmentType; /** Price adjustment value. */ adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; /** The number of cycles required before this pricing policy applies. */ afterCycle: Scalars['Int']; /** The computed price after the adjustments applied. */ computedPrice: MoneyV2; }; /** Describes the delivery method to use to get the physical goods to the customer. */ export type SubscriptionDeliveryMethod = SubscriptionDeliveryMethodShipping; /** * Specifies delivery method fields for a subscription draft. * This is an input union: one, and only one, field can be provided. * The field provided will determine which delivery method is to be used. * * Note: Only `shipping` is supported for now, but other inputs will be * added as they become supported in subscriptions. */ export type SubscriptionDeliveryMethodInput = { /** Shipping delivery method input. */ shipping?: Maybe; }; /** Represents a shipping delivery method: a mailing address and a shipping option. */ export type SubscriptionDeliveryMethodShipping = { __typename?: 'SubscriptionDeliveryMethodShipping'; /** The address to ship to. */ address: SubscriptionMailingAddress; /** The details of the shipping method to use. */ shippingOption: SubscriptionDeliveryMethodShippingOption; }; /** * Specifies shipping delivery method fields. * * This input accepts partial input. When a field is not provided, * its prior value is left unchanged. */ export type SubscriptionDeliveryMethodShippingInput = { /** The address to ship to. */ address?: Maybe; /** The details of the shipping method to use. */ shippingOption?: Maybe; }; /** Represents the selected shipping option on a subscription contract. */ export type SubscriptionDeliveryMethodShippingOption = { __typename?: 'SubscriptionDeliveryMethodShippingOption'; /** The carrier service of the shipping option. */ carrierService?: Maybe; /** The code of the shipping option. */ code?: Maybe; /** The description of the shipping option. */ description?: Maybe; /** The presentment title of the shipping option. */ presentmentTitle?: Maybe; /** The title of the shipping option. */ title?: Maybe; }; /** Specifies shipping option fields. */ export type SubscriptionDeliveryMethodShippingOptionInput = { /** The title of the shipping option. */ title?: Maybe; /** The presentment title of the shipping option. */ presentmentTitle?: Maybe; /** The description of the shipping option. */ description?: Maybe; /** The code of the shipping option. */ code?: Maybe; /** The carrier service ID of the shipping option. */ carrierServiceId?: Maybe; }; /** Represents a Subscription Delivery Policy. */ export type SubscriptionDeliveryPolicy = { __typename?: 'SubscriptionDeliveryPolicy'; /** Specific anchor dates upon which the delivery interval calculations should be made. */ anchors: Array; /** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */ interval: SellingPlanInterval; /** The number of delivery intervals between deliveries. */ intervalCount: Scalars['Int']; }; /** Specifies the input fields for a Subscription Delivery Policy. */ export type SubscriptionDeliveryPolicyInput = { /** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */ interval: SellingPlanInterval; /** The number of billing intervals between invoices. */ intervalCount: Scalars['Int']; /** Specific anchor dates upon which the delivery interval calculations should be made. */ anchors?: Maybe>; }; /** Subscription draft discount types. */ export type SubscriptionDiscount = SubscriptionAppliedCodeDiscount | SubscriptionManualDiscount; /** Represents what a particular discount reduces from a line price. */ export type SubscriptionDiscountAllocation = { __typename?: 'SubscriptionDiscountAllocation'; /** Allocation amount. */ amount: MoneyV2; /** Discount that created the allocation. */ discount: SubscriptionDiscount; }; /** An auto-generated type for paginating through multiple SubscriptionDiscounts. */ export type SubscriptionDiscountConnection = { __typename?: 'SubscriptionDiscountConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination. */ export type SubscriptionDiscountEdge = { __typename?: 'SubscriptionDiscountEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SubscriptionDiscountEdge. */ node: SubscriptionDiscount; }; /** Represents the subscription lines the discount applies on. */ export type SubscriptionDiscountEntitledLines = { __typename?: 'SubscriptionDiscountEntitledLines'; /** Specify whether the subscription discount will apply on all subscription lines. */ all: Scalars['Boolean']; /** The list of subscription lines associated with the subscription discount. */ lines: SubscriptionLineConnection; }; /** Represents the subscription lines the discount applies on. */ export type SubscriptionDiscountEntitledLinesLinesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** The value of the discount and how it will be applied. */ export type SubscriptionDiscountFixedAmountValue = { __typename?: 'SubscriptionDiscountFixedAmountValue'; /** The fixed amount value of the discount. */ amount: MoneyV2; /** Whether the amount is applied per item. */ appliesOnEachItem: Scalars['Boolean']; }; /** The percentage value of the discount. */ export type SubscriptionDiscountPercentageValue = { __typename?: 'SubscriptionDiscountPercentageValue'; /** The percentage value of the discount. */ percentage: Scalars['Int']; }; /** The reason a discount on a subscription draft was rejected. */ export enum SubscriptionDiscountRejectionReason { /** Discount code is not found. */ NotFound = 'NOT_FOUND', /** Discount does not apply to any of the given line items. */ NoEntitledLineItems = 'NO_ENTITLED_LINE_ITEMS', /** Quantity of items does not qualify for the discount. */ QuantityNotInRange = 'QUANTITY_NOT_IN_RANGE', /** Purchase amount of items does not qualify for the discount. */ PurchaseNotInRange = 'PURCHASE_NOT_IN_RANGE', /** Given customer does not qualify for the discount. */ CustomerNotEligible = 'CUSTOMER_NOT_ELIGIBLE', /** Discount usage limit has been reached. */ UsageLimitReached = 'USAGE_LIMIT_REACHED', /** Customer usage limit has been reached. */ CustomerUsageLimitReached = 'CUSTOMER_USAGE_LIMIT_REACHED', /** Discount is inactive. */ CurrentlyInactive = 'CURRENTLY_INACTIVE', /** No applicable shipping lines. */ NoEntitledShippingLines = 'NO_ENTITLED_SHIPPING_LINES', /** Purchase type does not qualify for the discount. */ IncompatiblePurchaseType = 'INCOMPATIBLE_PURCHASE_TYPE', /** Internal error during discount code validation. */ InternalError = 'INTERNAL_ERROR' } /** The value of the discount and how it will be applied. */ export type SubscriptionDiscountValue = SubscriptionDiscountFixedAmountValue | SubscriptionDiscountPercentageValue; /** Represents a Subscription Draft. */ export type SubscriptionDraft = Node & { __typename?: 'SubscriptionDraft'; /** The billing policy for the subscription contract. */ billingPolicy: SubscriptionBillingPolicy; /** The currency used for the subscription contract. */ currencyCode: CurrencyCode; /** The customer to whom the subscription contract belongs. */ customer: Customer; /** The customer payment method used for the subscription contract. */ customerPaymentMethod?: Maybe; /** The delivery method for each billing of the subscription contract. */ deliveryMethod?: Maybe; /** The delivery policy for the subscription contract. */ deliveryPolicy: SubscriptionDeliveryPolicy; /** The delivery price for each billing the subscription contract. */ deliveryPrice?: Maybe; /** The list of subscription discounts which will be associated with the subscription contract. */ discounts: SubscriptionDiscountConnection; /** The list of subscription discounts to be added to the subscription contract. */ discountsAdded: SubscriptionDiscountConnection; /** The list of subscription discounts to be removed from the subscription contract. */ discountsRemoved: SubscriptionDiscountConnection; /** The list of subscription discounts to be updated on the subscription contract. */ discountsUpdated: SubscriptionDiscountConnection; /** Globally unique identifier. */ id: Scalars['ID']; /** The list of subscription lines which will be associated with the subscription contract. */ lines: SubscriptionLineConnection; /** The list of subscription lines to be added to the subscription contract. */ linesAdded: SubscriptionLineConnection; /** The list of subscription lines to be removed from the subscription contract. */ linesRemoved: SubscriptionLineConnection; /** The next billing date for the subscription contract. */ nextBillingDate?: Maybe; /** The original subscription contract. */ originalContract?: Maybe; /** Available Shipping Options for a given delivery address. Returns NULL for pending requests. */ shippingOptions?: Maybe; /** The current status of the subscription contract. */ status?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftCustomerPaymentMethodArgs = { showRevoked?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftDiscountsArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftDiscountsAddedArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftDiscountsRemovedArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftDiscountsUpdatedArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftLinesArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftLinesAddedArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftLinesRemovedArgs = { first?: Maybe; after?: Maybe; last?: Maybe; before?: Maybe; reverse?: Maybe; }; /** Represents a Subscription Draft. */ export type SubscriptionDraftShippingOptionsArgs = { deliveryAddress?: Maybe; }; /** Return type for `subscriptionDraftCommit` mutation. */ export type SubscriptionDraftCommitPayload = { __typename?: 'SubscriptionDraftCommitPayload'; /** The updated Subscription Contract object. */ contract?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftDiscountAdd` mutation. */ export type SubscriptionDraftDiscountAddPayload = { __typename?: 'SubscriptionDraftDiscountAddPayload'; /** The added Subscription Discount. */ discountAdded?: Maybe; /** The Subscription Contract draft object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftDiscountCodeApply` mutation. */ export type SubscriptionDraftDiscountCodeApplyPayload = { __typename?: 'SubscriptionDraftDiscountCodeApplyPayload'; /** The added subscription discount. */ appliedDiscount?: Maybe; /** The subscription contract draft object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftDiscountRemove` mutation. */ export type SubscriptionDraftDiscountRemovePayload = { __typename?: 'SubscriptionDraftDiscountRemovePayload'; /** The removed subscription draft discount. */ discountRemoved?: Maybe; /** The subscription contract draft object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftDiscountUpdate` mutation. */ export type SubscriptionDraftDiscountUpdatePayload = { __typename?: 'SubscriptionDraftDiscountUpdatePayload'; /** The updated Subscription Discount. */ discountUpdated?: Maybe; /** The Subscription Contract draft object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Possible error codes that could be returned by SubscriptionDraftUserError. */ export enum SubscriptionDraftErrorCode { /** This line has already been removed. */ AlreadyRemoved = 'ALREADY_REMOVED', /** Input value is not present. */ Presence = 'PRESENCE', /** Subscription draft has been already committed. */ Committed = 'COMMITTED', /** Value is not in range. */ NotInRange = 'NOT_IN_RANGE', /** The value is not an integer. */ NotAnInteger = 'NOT_AN_INTEGER', /** The maximum number of cycles must be greater than the minimum. */ SellingPlanMaxCyclesMustBeGreaterThanMinCycles = 'SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES', /** The delivery policy interval must be a multiple of the billing policy interval. */ DeliveryMustBeMultipleOfBilling = 'DELIVERY_MUST_BE_MULTIPLE_OF_BILLING', /** Next billing date is invalid. */ InvalidBillingDate = 'INVALID_BILLING_DATE', /** Must have at least one line. */ InvalidLines = 'INVALID_LINES', /** Discount must have at least one entitled line. */ NoEntitledLines = 'NO_ENTITLED_LINES', /** The customer doesn't exist. */ CustomerDoesNotExist = 'CUSTOMER_DOES_NOT_EXIST', /** The payment method customer must be the same as the contract customer. */ CustomerMismatch = 'CUSTOMER_MISMATCH', /** The delivery method can't be blank if any lines require shipping. */ DeliveryMethodRequired = 'DELIVERY_METHOD_REQUIRED', /** The after cycle attribute must be unique between cycle discounts. */ CycleDiscountsUniqueAfterCycle = 'CYCLE_DISCOUNTS_UNIQUE_AFTER_CYCLE', /** The adjustment value must the same type as the adjustment type. */ InvalidAdjustmentType = 'INVALID_ADJUSTMENT_TYPE', /** The adjustment value must be either fixed_value or percentage. */ InvalidAdjustmentValue = 'INVALID_ADJUSTMENT_VALUE', /** Another operation updated the contract concurrently as the commit was in progress. */ StaleContract = 'STALE_CONTRACT', /** Currency is not enabled. */ CurrencyNotEnabled = 'CURRENCY_NOT_ENABLED', /** Input value is invalid. */ Invalid = 'INVALID', /** Input value is blank. */ Blank = 'BLANK', /** Input value should be greater than minimum allowed value. */ GreaterThan = 'GREATER_THAN', /** Input value should be greater than or equal to minimum allowed value. */ GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', /** Input value should be less than maximum allowed value. */ LessThan = 'LESS_THAN', /** Input value should be less or equal to maximum allowed value. */ LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO', /** Input value is too long. */ TooLong = 'TOO_LONG', /** Input value is too short. */ TooShort = 'TOO_SHORT' } /** Return type for `subscriptionDraftFreeShippingDiscountAdd` mutation. */ export type SubscriptionDraftFreeShippingDiscountAddPayload = { __typename?: 'SubscriptionDraftFreeShippingDiscountAddPayload'; /** The added subscription free shipping discount. */ discountAdded?: Maybe; /** The subscription contract draft object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftFreeShippingDiscountUpdate` mutation. */ export type SubscriptionDraftFreeShippingDiscountUpdatePayload = { __typename?: 'SubscriptionDraftFreeShippingDiscountUpdatePayload'; /** The updated Subscription Discount. */ discountUpdated?: Maybe; /** The Subscription Contract draft object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Specifies the input fields required to create a Subscription Draft. */ export type SubscriptionDraftInput = { /** The current status of the subscription contract. */ status?: Maybe; /** The ID of the payment method to be used for the subscription contract. */ paymentMethodId?: Maybe; /** The next billing date for the subscription contract. */ nextBillingDate?: Maybe; /** The billing policy for the subscription contract. */ billingPolicy?: Maybe; /** The delivery policy for the subscription contract. */ deliveryPolicy?: Maybe; /** The shipping price for each renewal the subscription contract. */ deliveryPrice?: Maybe; /** The delivery method for the subscription contract. */ deliveryMethod?: Maybe; }; /** Return type for `subscriptionDraftLineAdd` mutation. */ export type SubscriptionDraftLineAddPayload = { __typename?: 'SubscriptionDraftLineAddPayload'; /** The Subscription Contract draft object. */ draft?: Maybe; /** The added Subscription Line. */ lineAdded?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftLineRemove` mutation. */ export type SubscriptionDraftLineRemovePayload = { __typename?: 'SubscriptionDraftLineRemovePayload'; /** The list of updated subscription discounts impacted by the removed line. */ discountsUpdated?: Maybe>; /** The Subscription Contract draft object. */ draft?: Maybe; /** The removed Subscription Line. */ lineRemoved?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftLineUpdate` mutation. */ export type SubscriptionDraftLineUpdatePayload = { __typename?: 'SubscriptionDraftLineUpdatePayload'; /** The Subscription Contract draft object. */ draft?: Maybe; /** The updated Subscription Line. */ lineUpdated?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionDraftUpdate` mutation. */ export type SubscriptionDraftUpdatePayload = { __typename?: 'SubscriptionDraftUpdatePayload'; /** The Subscription Draft object. */ draft?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Represents a Subscription Draft error. */ export type SubscriptionDraftUserError = DisplayableError & { __typename?: 'SubscriptionDraftUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Specifies the input fields of a subscription free shipping discount on a contract. */ export type SubscriptionFreeShippingDiscountInput = { /** The title associated with the subscription free shipping discount. */ title?: Maybe; /** The maximum number of times the subscription free shipping discount will be applied on orders. */ recurringCycleLimit?: Maybe; }; /** Represents a Subscription Line. */ export type SubscriptionLine = { __typename?: 'SubscriptionLine'; /** The price per unit for the subscription line in the contract's currency. */ currentPrice: MoneyV2; /** List of custom attributes associated to the line item. */ customAttributes: Array; /** Discount allocations. */ discountAllocations: Array; /** The unique identifier. */ id: Scalars['ID']; /** Total line price including all discounts. */ lineDiscountedPrice: MoneyV2; /** Describe the price changes of the line over time. */ pricingPolicy?: Maybe; /** The product id associated with the subscription line. */ productId?: Maybe; /** The quantity of the unit selected for the subscription line. */ quantity: Scalars['Int']; /** Whether physical shipping is required for the variant. */ requiresShipping: Scalars['Boolean']; /** * The selling plan ID associated to the line. * * Indicates which selling plan was used to create this * contract line initially. The selling plan ID is also used to * find the associated delivery profile. * * The subscription contract, subscription line, or selling plan might have * changed. As a result, the selling plan's attributes might not * match the information on the contract. */ sellingPlanId?: Maybe; /** * The selling plan name associated to the line. This name describes * the order line items created from this subscription line * for both merchants and customers. * * The value can be different from the selling plan's name, because both * the selling plan's name and the subscription line's selling_plan_name * attribute can be updated independently. */ sellingPlanName?: Maybe; /** Variant SKU number of the item associated with the subscription line. */ sku?: Maybe; /** Whether the variant is taxable. */ taxable: Scalars['Boolean']; /** Product title of the item associated with the subscription line. */ title: Scalars['String']; /** The product variant id associated with the subscription line. */ variantId?: Maybe; /** The image associated with the line item's variant or product. */ variantImage?: Maybe; /** Product variant title of the item associated with the subscription line. */ variantTitle?: Maybe; }; /** An auto-generated type for paginating through multiple SubscriptionLines. */ export type SubscriptionLineConnection = { __typename?: 'SubscriptionLineConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SubscriptionLine and a cursor during pagination. */ export type SubscriptionLineEdge = { __typename?: 'SubscriptionLineEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SubscriptionLineEdge. */ node: SubscriptionLine; }; /** Specifies the input fields required to add a new subscription line to a contract. */ export type SubscriptionLineInput = { /** The ID of the product variant the subscription line refers to. */ productVariantId: Scalars['ID']; /** The quantity of the product. */ quantity: Scalars['Int']; /** The price of the product. */ currentPrice: Scalars['Decimal']; /** The custom attributes for this subscription line. */ customAttributes?: Maybe>; /** The selling plan for the subscription line. */ sellingPlanId?: Maybe; /** * The selling plan name for the subscription line. * * Defaults to using the selling plan's current name when not specified. */ sellingPlanName?: Maybe; /** Describes expected price changes of the subscription line over time. */ pricingPolicy?: Maybe; }; /** Specifies the input fields required to update a subscription line on a contract. */ export type SubscriptionLineUpdateInput = { /** The ID of the product variant the subscription line refers to. */ productVariantId?: Maybe; /** The quantity of the product. */ quantity?: Maybe; /** The selling plan for the subscription line. */ sellingPlanId?: Maybe; /** The selling plan name for the subscription line. */ sellingPlanName?: Maybe; /** The price of the product. */ currentPrice?: Maybe; /** The custom attributes for this subscription line. */ customAttributes?: Maybe>; /** Describes expected price changes of the subscription line over time. */ pricingPolicy?: Maybe; }; /** Represents a Mailing Address on a Subscription. */ export type SubscriptionMailingAddress = { __typename?: 'SubscriptionMailingAddress'; /** The first line of the address. Typically the street address or PO Box number. */ address1?: Maybe; /** The second line of the address. Typically the number of the apartment, suite, or unit. */ address2?: Maybe; /** The name of the city, district, village, or town. */ city?: Maybe; /** The name of the customer's company or organization. */ company?: Maybe; /** The name of the country. */ country?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. */ countryCode?: Maybe; /** The first name of the customer. */ firstName?: Maybe; /** The last name of the customer. */ lastName?: Maybe; /** The full name of the customer, based on firstName and lastName. */ name?: Maybe; /** A unique phone number for the customer. Formatted using E.164 standard. For example, _+16135551111_. */ phone?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** * The two-letter code for the region. * * For example, ON. */ provinceCode?: Maybe; /** The zip or postal code of the address. */ zip?: Maybe; }; /** Custom subscription discount. */ export type SubscriptionManualDiscount = { __typename?: 'SubscriptionManualDiscount'; /** Entitled line items used to apply the subscription discount on. */ entitledLines: SubscriptionDiscountEntitledLines; /** The unique identifier. */ id: Scalars['ID']; /** The maximum number of times the subscription discount will be applied on orders. */ recurringCycleLimit?: Maybe; /** The reason that the discount on the subscription draft is rejected. */ rejectionReason?: Maybe; /** Type of line the discount applies on. */ targetType: DiscountTargetType; /** The title associated with the subscription discount. */ title?: Maybe; /** The type of the subscription discount. */ type: DiscountType; /** The number of times the discount was applied. */ usageCount: Scalars['Int']; /** The value of the subscription discount. */ value: SubscriptionDiscountValue; }; /** An auto-generated type for paginating through multiple SubscriptionManualDiscounts. */ export type SubscriptionManualDiscountConnection = { __typename?: 'SubscriptionManualDiscountConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SubscriptionManualDiscount and a cursor during pagination. */ export type SubscriptionManualDiscountEdge = { __typename?: 'SubscriptionManualDiscountEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of SubscriptionManualDiscountEdge. */ node: SubscriptionManualDiscount; }; /** Represents the subscription lines the discount applies on. */ export type SubscriptionManualDiscountEntitledLinesInput = { /** Specify whether the subscription discount will apply on all subscription lines. */ all?: Maybe; /** The ID of the lines to add to or remove from the subscription discount. */ lines?: Maybe; }; /** Specifies the fixed amount value of the discount and distribution on the lines. */ export type SubscriptionManualDiscountFixedAmountInput = { /** Fixed amount value. */ amount?: Maybe; /** Whether the amount is intended per line item or once per subscription. */ appliesOnEachItem?: Maybe; }; /** Specifies the input fields of a subscription discount on a contract. */ export type SubscriptionManualDiscountInput = { /** The title associated with the subscription discount. */ title?: Maybe; /** Percentage or fixed amount value of the discount. */ value?: Maybe; /** The maximum number of times the subscription discount will be applied on orders. */ recurringCycleLimit?: Maybe; /** Entitled line items used to apply the subscription discount on. */ entitledLines?: Maybe; }; /** Line items that a the discount refers to. */ export type SubscriptionManualDiscountLinesInput = { /** The ID of the lines to add to the subscription discount. */ add?: Maybe>; /** The ID of the lines to remove from the subscription discount. */ remove?: Maybe>; }; /** Specifies the discount value and its distribution. */ export type SubscriptionManualDiscountValueInput = { /** The percentage value of the discount. Value must be between 0 - 100. */ percentage?: Maybe; /** Fixed amount input in the currency defined by the subscription. */ fixedAmount?: Maybe; }; /** Represents a Subscription Line Pricing Policy. */ export type SubscriptionPricingPolicy = { __typename?: 'SubscriptionPricingPolicy'; /** The base price per unit for the subscription line in the contract's currency. */ basePrice: MoneyV2; /** The adjustments per cycle for the subscription line. */ cycleDiscounts: Array; }; /** An array containing all pricing changes for each billing cycle. */ export type SubscriptionPricingPolicyCycleDiscountsInput = { /** The cycle after which the pricing policy applies. */ afterCycle: Scalars['Int']; /** The price adjustment type. */ adjustmentType: SellingPlanPricingPolicyAdjustmentType; /** The price adjustment value. */ adjustmentValue: SellingPlanPricingPolicyValueInput; /** The computed price after the adjustments are applied. */ computedPrice: Scalars['Decimal']; }; /** Describes expected price changes of the subscription line over time. */ export type SubscriptionPricingPolicyInput = { /** The base price per unit for the subscription line in the contract's currency. */ basePrice: Scalars['Decimal']; /** An array containing all pricing changes for each billing cycle. */ cycleDiscounts: Array; }; /** A shipping option to deliver a subscription contract. */ export type SubscriptionShippingOption = { __typename?: 'SubscriptionShippingOption'; /** * The carrier service that is providing this shipping option. * This field isn't currently supported and returns null. */ carrierService?: Maybe; /** The code of the shipping option. */ code: Scalars['String']; /** The description of the shipping option. */ description?: Maybe; /** If a phone number is required for the shipping option. */ phoneRequired?: Maybe; /** The presentment title of the shipping option. */ presentmentTitle?: Maybe; /** The price of the shipping option. */ price?: Maybe; /** The title of the shipping option. */ title: Scalars['String']; }; /** The result of the query to fetch shipping options for the subscription contract. */ export type SubscriptionShippingOptionResult = SubscriptionShippingOptionResultFailure | SubscriptionShippingOptionResultSuccess; /** Failure determining available shipping options for delivery of a subscription contract. */ export type SubscriptionShippingOptionResultFailure = { __typename?: 'SubscriptionShippingOptionResultFailure'; /** Failure reason. */ message?: Maybe; }; /** A shipping option for delivery of a subscription contract. */ export type SubscriptionShippingOptionResultSuccess = { __typename?: 'SubscriptionShippingOptionResultSuccess'; /** Available shipping options. */ shippingOptions: Array; }; /** Represents a suggested transaction. */ export type SuggestedOrderTransaction = { __typename?: 'SuggestedOrderTransaction'; /** The masked account number associated with the payment method. */ accountNumber?: Maybe; /** * The amount of the transaction. * @deprecated Use `amountSet` instead */ amount: Scalars['Money']; /** The amount on the order transaction in applicable currencies. */ amountSet: MoneyBag; /** The human-readable payment gateway name used to process the transaction. */ formattedGateway?: Maybe; /** The payment gateway used to process the transaction. */ gateway?: Maybe; /** Specifies the kind of the suggested order transaction. */ kind: SuggestedOrderTransactionKind; /** * Specifies the available amount to refund on the gateway. Only available within SuggestedRefund. * @deprecated Use `maximumRefundableSet` instead */ maximumRefundable?: Maybe; /** Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund. */ maximumRefundableSet?: Maybe; /** The associated parent transaction, for example the authorization of a capture. */ parentTransaction?: Maybe; }; /** Specifies the kind of the suggested order transaction. */ export enum SuggestedOrderTransactionKind { /** A suggested refund transaction for an order. */ SuggestedRefund = 'SUGGESTED_REFUND' } /** Represents the suggested refund to be submitted based on the items being returned. */ export type SuggestedRefund = { __typename?: 'SuggestedRefund'; /** * The total monetary value to be refunded. * @deprecated Use `amountSet` instead */ amount: Scalars['Money']; /** The total monetary value to be refunded in shop and presentment currencies. */ amountSet: MoneyBag; /** The sum of all the discounted prices of the line items being refunded. */ discountedSubtotalSet: MoneyBag; /** * The total monetary value available to refund. * @deprecated Use `maximumRefundableSet` instead */ maximumRefundable: Scalars['Money']; /** The total monetary value available to refund in shop and presentment currencies. */ maximumRefundableSet: MoneyBag; /** An array of duties that will be refunded to the customer. */ refundDuties: Array; /** An array of line items that will be returned to the customer. */ refundLineItems: Array; /** Refund details for shipping costs paid by customer. */ shipping: ShippingRefund; /** * The sum of all the prices of the line items being refunded. * @deprecated Use `subtotalSet` instead */ subtotal: Scalars['Money']; /** The sum of all the prices of the line items being refunded in shop and presentment currencies. */ subtotalSet: MoneyBag; /** Array of SuggestedOrderTransaction items. */ suggestedTransactions: Array; /** The total cart discount amount that was applied to all line items in this refund. */ totalCartDiscountAmountSet: MoneyBag; /** The sum of all the duties being refunded from the order in shop and presentment currencies. Must be positive. */ totalDutiesSet: MoneyBag; /** The sum of all the taxes being refunded from the order (must be positive) in shop and presentment currencies. */ totalTaxSet: MoneyBag; /** * The sum of all the taxes being refunded from the order (must be positive). * @deprecated Use `totalTaxSet` instead */ totalTaxes: Scalars['Money']; }; /** Return type for `tagsAdd` mutation. */ export type TagsAddPayload = { __typename?: 'TagsAddPayload'; /** The object that was updated. */ node?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `tagsRemove` mutation. */ export type TagsRemovePayload = { __typename?: 'TagsRemovePayload'; /** The object that was updated. */ node?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Available customer tax exemptions. */ export enum TaxExemption { /** This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada. */ CaStatusCardExemption = 'CA_STATUS_CARD_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia. */ CaBcResellerExemption = 'CA_BC_RESELLER_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba. */ CaMbResellerExemption = 'CA_MB_RESELLER_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan. */ CaSkResellerExemption = 'CA_SK_RESELLER_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada. */ CaDiplomatExemption = 'CA_DIPLOMAT_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia. */ CaBcCommercialFisheryExemption = 'CA_BC_COMMERCIAL_FISHERY_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba. */ CaMbCommercialFisheryExemption = 'CA_MB_COMMERCIAL_FISHERY_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia. */ CaNsCommercialFisheryExemption = 'CA_NS_COMMERCIAL_FISHERY_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island. */ CaPeCommercialFisheryExemption = 'CA_PE_COMMERCIAL_FISHERY_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan. */ CaSkCommercialFisheryExemption = 'CA_SK_COMMERCIAL_FISHERY_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia. */ CaBcProductionAndMachineryExemption = 'CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan. */ CaSkProductionAndMachineryExemption = 'CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia. */ CaBcSubContractorExemption = 'CA_BC_SUB_CONTRACTOR_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan. */ CaSkSubContractorExemption = 'CA_SK_SUB_CONTRACTOR_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia. */ CaBcContractorExemption = 'CA_BC_CONTRACTOR_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan. */ CaSkContractorExemption = 'CA_SK_CONTRACTOR_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario. */ CaOnPurchaseExemption = 'CA_ON_PURCHASE_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba. */ CaMbFarmerExemption = 'CA_MB_FARMER_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia. */ CaNsFarmerExemption = 'CA_NS_FARMER_EXEMPTION', /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan. */ CaSkFarmerExemption = 'CA_SK_FARMER_EXEMPTION' } /** Represents the information about the tax charged on the associated line item. */ export type TaxLine = { __typename?: 'TaxLine'; /** * The amount of tax to be charged. * @deprecated Use `priceSet` instead */ price: Scalars['Money']; /** The amount of tax to be charged in shop and presentment currencies. */ priceSet: MoneyBag; /** The tax rate to be applied. */ rate?: Maybe; /** The percentage of the price that the tax rate represents. */ ratePercentage?: Maybe; /** The name of the tax. */ title: Scalars['String']; }; /** A tender transaction represents a transaction which modifies the shop's balance. */ export type TenderTransaction = Node & { __typename?: 'TenderTransaction'; /** The amount and currency of the tender transaction. */ amount: MoneyV2; /** Globally unique identifier. */ id: Scalars['ID']; /** Information about the payment method used for this transaction. */ paymentMethod?: Maybe; /** Date and time when the transaction was processed. */ processedAt?: Maybe; /** The remote gateway reference associated with the tender transaction. */ remoteReference?: Maybe; /** Whether the transaction is a test transaction. */ test: Scalars['Boolean']; /** Information about the payment instrument used for this transaction. */ transactionDetails?: Maybe; }; /** An auto-generated type for paginating through multiple TenderTransactions. */ export type TenderTransactionConnection = { __typename?: 'TenderTransactionConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Information about the credit card used for this transaction. */ export type TenderTransactionCreditCardDetails = { __typename?: 'TenderTransactionCreditCardDetails'; /** The name of the company that issued the customer's credit card. */ creditCardCompany?: Maybe; /** The customer's credit card number, with most of the leading digits redacted. */ creditCardNumber?: Maybe; }; /** Information about the payment instrument used for this transaction. */ export type TenderTransactionDetails = TenderTransactionCreditCardDetails; /** An auto-generated type which holds one TenderTransaction and a cursor during pagination. */ export type TenderTransactionEdge = { __typename?: 'TenderTransactionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of TenderTransactionEdge. */ node: TenderTransaction; }; /** Specifies the fields for tracking information. */ export type TrackingInfoInput = { /** The tracking number of the fulfillment. */ number?: Maybe; /** The URL to track the fulfillment. */ url?: Maybe; }; /** Specifies all possible fields for updating tracking information. */ export type TrackingInfoUpdateInput = { /** Tracking information consisting of one or more tracking URLs and numbers associated with the fulfillment. */ trackingDetails?: Maybe>; /** The name of the tracking company. */ trackingCompany?: Maybe; /** Indicates whether the customer will be notified of this update and future updates for this fulfillment. */ notifyCustomer?: Maybe; }; /** Transaction fee related to an order transaction. */ export type TransactionFee = Node & { __typename?: 'TransactionFee'; /** Amount of the fee. */ amount: MoneyV2; /** Flat rate charge for a transaction. */ flatFee: MoneyV2; /** Name of the credit card flat fee. */ flatFeeName?: Maybe; /** Globally unique identifier. */ id: Scalars['ID']; /** Percentage charge. */ rate: Scalars['Decimal']; /** Name of the credit card rate. */ rateName?: Maybe; /** Tax amount charged on the fee. */ taxAmount: MoneyV2; /** Name of the type of fee. */ type: Scalars['String']; }; /** Translatable content of a resource's field. */ export type TranslatableContent = { __typename?: 'TranslatableContent'; /** Digest (hash) of the content. */ digest?: Maybe; /** Content key. */ key: Scalars['String']; /** Content locale. */ locale: Scalars['String']; /** Content value. */ value?: Maybe; }; /** A resource that has translatable fields. */ export type TranslatableResource = { __typename?: 'TranslatableResource'; /** GID of the resource. */ resourceId: Scalars['ID']; /** Translatable content. */ translatableContent: Array; /** Translatable content translations. */ translations: Array; }; /** A resource that has translatable fields. */ export type TranslatableResourceTranslationsArgs = { locale: Scalars['String']; outdated?: Maybe; }; /** An auto-generated type for paginating through multiple TranslatableResources. */ export type TranslatableResourceConnection = { __typename?: 'TranslatableResourceConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one TranslatableResource and a cursor during pagination. */ export type TranslatableResourceEdge = { __typename?: 'TranslatableResourceEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of TranslatableResourceEdge. */ node: TranslatableResource; }; /** Specifies the type of resources that are translatable. */ export enum TranslatableResourceType { /** Represents a product. */ Product = 'PRODUCT', /** Represents a product variant. */ ProductVariant = 'PRODUCT_VARIANT', /** Represents an email template. */ EmailTemplate = 'EMAIL_TEMPLATE', /** Represents an online store theme. */ OnlineStoreTheme = 'ONLINE_STORE_THEME', /** Represents an article. */ OnlineStoreArticle = 'ONLINE_STORE_ARTICLE', /** Represents an online store blog. */ OnlineStoreBlog = 'ONLINE_STORE_BLOG', /** Represents an online store page. */ OnlineStorePage = 'ONLINE_STORE_PAGE', /** Represents a collection of products. */ Collection = 'COLLECTION', /** Represents a link to direct users to. */ Link = 'LINK', /** Represents a metafield. */ Metafield = 'METAFIELD', /** Represents an SMS template. */ SmsTemplate = 'SMS_TEMPLATE', /** Represents a shop. */ Shop = 'SHOP', /** Represents a shop policy. */ ShopPolicy = 'SHOP_POLICY', /** Represents a payment gateway. */ PaymentGateway = 'PAYMENT_GATEWAY', /** Represents a custom product property name like "Size", "Color", and "Material". */ ProductOption = 'PRODUCT_OPTION', /** Represents a delivery method definition. For example, "Standard", or "Expedited". */ DeliveryMethodDefinition = 'DELIVERY_METHOD_DEFINITION' } /** Translation of a field of a resource. */ export type Translation = { __typename?: 'Translation'; /** Translation key. */ key: Scalars['String']; /** Translation locale. */ locale: Scalars['String']; /** Marked as outdated. */ outdated: Scalars['Boolean']; /** Translation value. */ value?: Maybe; }; /** Possible error codes that could be returned by TranslationUserError. */ export enum TranslationErrorCode { /** Input value is blank. */ Blank = 'BLANK', /** Input value is invalid. */ Invalid = 'INVALID', /** Resource does not exist. */ ResourceNotFound = 'RESOURCE_NOT_FOUND', /** Too many translation keys for resource. */ TooManyKeysForResource = 'TOO_MANY_KEYS_FOR_RESOURCE', /** Translation key is invalid. */ InvalidKeyForModel = 'INVALID_KEY_FOR_MODEL', /** Translation value is invalid. */ FailsResourceValidation = 'FAILS_RESOURCE_VALIDATION', /** Translatable content is invalid. */ InvalidTranslatableContent = 'INVALID_TRANSLATABLE_CONTENT', /** Locale is invalid for the shop. */ InvalidLocaleForShop = 'INVALID_LOCALE_FOR_SHOP', /** Locale language code is invalid. */ InvalidCode = 'INVALID_CODE', /** Locale code format is invalid. */ InvalidFormat = 'INVALID_FORMAT' } /** Provides the fields and values to use when creating or updating a translation. */ export type TranslationInput = { /** The locale of the translation. */ locale: Scalars['String']; /** The key of the translation. */ key: Scalars['String']; /** The value of the translation. */ value: Scalars['String']; /** The digest (hash) of the content being translated. */ translatableContentDigest: Scalars['String']; }; /** Represents an error that happens during the execution of a translation mutation. */ export type TranslationUserError = DisplayableError & { __typename?: 'TranslationUserError'; /** Error code to uniquely identify the error. */ code?: Maybe; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Return type for `translationsRegister` mutation. */ export type TranslationsRegisterPayload = { __typename?: 'TranslationsRegisterPayload'; /** The translations that were created or updated. */ translations?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `translationsRemove` mutation. */ export type TranslationsRemovePayload = { __typename?: 'TranslationsRemovePayload'; /** The translations that were deleted. */ translations?: Maybe>; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** * Specifies the * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) * that are associated with a related marketing campaign. */ export type UtmInput = { /** The name of the UTM campaign. */ campaign: Scalars['String']; /** The name of the website or application where the referral link exists. */ source: Scalars['String']; /** The UTM campaign medium. */ medium: Scalars['String']; }; /** Represents a set of UTM parameters. */ export type UtmParameters = { __typename?: 'UTMParameters'; /** The name of a marketing campaign. */ campaign?: Maybe; /** Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective. */ content?: Maybe; /** The medium of a marketing campaign, such as a banner or email newsletter. */ medium?: Maybe; /** The source of traffic to the merchant's store, such as Google or an email newsletter. */ source?: Maybe; /** Paid search terms used by a marketing campaign. */ term?: Maybe; }; /** Systems of weights and measures. */ export enum UnitSystem { /** Imperial system of weights and measures. */ ImperialSystem = 'IMPERIAL_SYSTEM', /** Metric system of weights and measures. */ MetricSystem = 'METRIC_SYSTEM' } /** Specifies the input fields required to update a media object. */ export type UpdateMediaInput = { /** Specifies the media to update. */ id: Scalars['ID']; /** The source from which to update the media preview image. May be an external URL or signed upload URL. */ previewImageSource?: Maybe; /** The alt text associated to the media. */ alt?: Maybe; }; /** Represents an error in the input of a mutation. */ export type UserError = DisplayableError & { __typename?: 'UserError'; /** Path to the input field which caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']; }; /** Represents a Shopify hosted video. */ export type Video = Node & Media & { __typename?: 'Video'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** The filename of the video. */ filename: Scalars['String']; /** Globally unique identifier. */ id: Scalars['ID']; /** The media content type. */ mediaContentType: MediaContentType; /** Any errors which have occurred on the media. */ mediaErrors: Array; /** The original source for a video. */ originalSource?: Maybe; /** The preview image for the media. */ preview?: Maybe; /** The sources for a video. */ sources: Array; /** Current status of the media. */ status: MediaStatus; }; /** Represents a source for a Shopify hosted video. */ export type VideoSource = { __typename?: 'VideoSource'; /** The format of the video source. */ format: Scalars['String']; /** The height of the video. */ height: Scalars['Int']; /** The video MIME type. */ mimeType: Scalars['String']; /** The URL of the video. */ url: Scalars['String']; /** The width of the video. */ width: Scalars['Int']; }; /** Amazon EventBridge event source. */ export type WebhookEventBridgeEndpoint = { __typename?: 'WebhookEventBridgeEndpoint'; /** ARN of this EventBridge event source. */ arn: Scalars['ARN']; }; /** HTTP endpoint where POST requests will be made to. */ export type WebhookHttpEndpoint = { __typename?: 'WebhookHttpEndpoint'; /** URL of webhook endpoint to deliver webhooks to. */ callbackUrl: Scalars['URL']; }; /** Represents a subscription to a webhook. */ export type WebhookSubscription = Node & LegacyInteroperability & { __typename?: 'WebhookSubscription'; /** * URL where the webhook subscription should send the POST request when the event occurs. * @deprecated Use `endpoint` instead */ callbackUrl: Scalars['URL']; /** The date and time when the webhook subscription was created. */ createdAt: Scalars['DateTime']; /** Endpoint where webhooks will be delivered to. */ endpoint: WebhookSubscriptionEndpoint; /** The format in which the webhook subscription should send the data. */ format: WebhookSubscriptionFormat; /** Globally unique identifier. */ id: Scalars['ID']; /** The list of fields to be included in the webhook subscription. */ includeFields: Array; /** The ID of the corresponding resource in the REST Admin API. */ legacyResourceId: Scalars['UnsignedInt64']; /** The list of namespaces for any metafields that should be included in the webhook subscription. */ metafieldNamespaces: Array; /** The type of event that triggers the webhook. */ topic: WebhookSubscriptionTopic; /** The date and time when the webhook subscription was updated. */ updatedAt: Scalars['DateTime']; }; /** An auto-generated type for paginating through multiple WebhookSubscriptions. */ export type WebhookSubscriptionConnection = { __typename?: 'WebhookSubscriptionConnection'; /** A list of edges. */ edges: Array; /** Information to aid in pagination. */ pageInfo: PageInfo; }; /** Return type for `webhookSubscriptionCreate` mutation. */ export type WebhookSubscriptionCreatePayload = { __typename?: 'WebhookSubscriptionCreatePayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; /** The webhook subscription that was created. */ webhookSubscription?: Maybe; }; /** Return type for `webhookSubscriptionDelete` mutation. */ export type WebhookSubscriptionDeletePayload = { __typename?: 'WebhookSubscriptionDeletePayload'; /** The ID of the deleted webhook subscription. */ deletedWebhookSubscriptionId?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one WebhookSubscription and a cursor during pagination. */ export type WebhookSubscriptionEdge = { __typename?: 'WebhookSubscriptionEdge'; /** A cursor for use in pagination. */ cursor: Scalars['String']; /** The item at the end of WebhookSubscriptionEdge. */ node: WebhookSubscription; }; /** Endpoint where webhooks will be delivered. */ export type WebhookSubscriptionEndpoint = WebhookEventBridgeEndpoint | WebhookHttpEndpoint; /** The supported formats for webhook subscriptions. */ export enum WebhookSubscriptionFormat { Json = 'JSON', Xml = 'XML' } /** Specifies the input fields for a webhook subscription. */ export type WebhookSubscriptionInput = { /** URL where the webhook subscription should send the POST request when the event occurs. */ callbackUrl?: Maybe; /** The format in which the webhook subscription should send the data. */ format?: Maybe; /** The list of fields to be included in the webhook subscription. */ includeFields?: Maybe>; /** The list of namespaces for any metafields that should be included in the webhook subscription. */ metafieldNamespaces?: Maybe>; }; /** The set of valid sort keys for the WebhookSubscription query. */ export enum WebhookSubscriptionSortKeys { /** Sort by the `created_at` value. */ CreatedAt = 'CREATED_AT', /** Sort by the `id` value. */ Id = 'ID', /** * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the * results by relevance to the search term(s). When no search query is specified, this sort key is not * deterministic and should not be used. */ Relevance = 'RELEVANCE' } /** The supported topics for webhook subscriptions. */ export enum WebhookSubscriptionTopic { /** The webhook topic for `app/uninstalled` events. */ AppUninstalled = 'APP_UNINSTALLED', /** The webhook topic for `carts/create` events. */ CartsCreate = 'CARTS_CREATE', /** The webhook topic for `carts/update` events. */ CartsUpdate = 'CARTS_UPDATE', /** The webhook topic for `channels/delete` events. */ ChannelsDelete = 'CHANNELS_DELETE', /** The webhook topic for `checkouts/create` events. */ CheckoutsCreate = 'CHECKOUTS_CREATE', /** The webhook topic for `checkouts/delete` events. */ CheckoutsDelete = 'CHECKOUTS_DELETE', /** The webhook topic for `checkouts/update` events. */ CheckoutsUpdate = 'CHECKOUTS_UPDATE', /** The webhook topic for `customer_payment_methods/create` events. */ CustomerPaymentMethodsCreate = 'CUSTOMER_PAYMENT_METHODS_CREATE', /** The webhook topic for `customer_payment_methods/update` events. */ CustomerPaymentMethodsUpdate = 'CUSTOMER_PAYMENT_METHODS_UPDATE', /** The webhook topic for `customer_payment_methods/revoke` events. */ CustomerPaymentMethodsRevoke = 'CUSTOMER_PAYMENT_METHODS_REVOKE', /** The webhook topic for `collection_listings/add` events. */ CollectionListingsAdd = 'COLLECTION_LISTINGS_ADD', /** The webhook topic for `collection_listings/remove` events. */ CollectionListingsRemove = 'COLLECTION_LISTINGS_REMOVE', /** The webhook topic for `collection_listings/update` events. */ CollectionListingsUpdate = 'COLLECTION_LISTINGS_UPDATE', /** The webhook topic for `collection_publications/create` events. */ CollectionPublicationsCreate = 'COLLECTION_PUBLICATIONS_CREATE', /** The webhook topic for `collection_publications/delete` events. */ CollectionPublicationsDelete = 'COLLECTION_PUBLICATIONS_DELETE', /** The webhook topic for `collection_publications/update` events. */ CollectionPublicationsUpdate = 'COLLECTION_PUBLICATIONS_UPDATE', /** The webhook topic for `collections/create` events. */ CollectionsCreate = 'COLLECTIONS_CREATE', /** The webhook topic for `collections/delete` events. */ CollectionsDelete = 'COLLECTIONS_DELETE', /** The webhook topic for `collections/update` events. */ CollectionsUpdate = 'COLLECTIONS_UPDATE', /** The webhook topic for `customer_groups/create` events. */ CustomerGroupsCreate = 'CUSTOMER_GROUPS_CREATE', /** The webhook topic for `customer_groups/delete` events. */ CustomerGroupsDelete = 'CUSTOMER_GROUPS_DELETE', /** The webhook topic for `customer_groups/update` events. */ CustomerGroupsUpdate = 'CUSTOMER_GROUPS_UPDATE', /** The webhook topic for `customers/create` events. */ CustomersCreate = 'CUSTOMERS_CREATE', /** The webhook topic for `customers/delete` events. */ CustomersDelete = 'CUSTOMERS_DELETE', /** The webhook topic for `customers/disable` events. */ CustomersDisable = 'CUSTOMERS_DISABLE', /** The webhook topic for `customers/enable` events. */ CustomersEnable = 'CUSTOMERS_ENABLE', /** The webhook topic for `customers/update` events. */ CustomersUpdate = 'CUSTOMERS_UPDATE', /** The webhook topic for `disputes/create` events. */ DisputesCreate = 'DISPUTES_CREATE', /** The webhook topic for `disputes/update` events. */ DisputesUpdate = 'DISPUTES_UPDATE', /** The webhook topic for `draft_orders/create` events. */ DraftOrdersCreate = 'DRAFT_ORDERS_CREATE', /** The webhook topic for `draft_orders/delete` events. */ DraftOrdersDelete = 'DRAFT_ORDERS_DELETE', /** The webhook topic for `draft_orders/update` events. */ DraftOrdersUpdate = 'DRAFT_ORDERS_UPDATE', /** The webhook topic for `fulfillment_events/create` events. */ FulfillmentEventsCreate = 'FULFILLMENT_EVENTS_CREATE', /** The webhook topic for `fulfillment_events/delete` events. */ FulfillmentEventsDelete = 'FULFILLMENT_EVENTS_DELETE', /** The webhook topic for `fulfillments/create` events. */ FulfillmentsCreate = 'FULFILLMENTS_CREATE', /** The webhook topic for `fulfillments/update` events. */ FulfillmentsUpdate = 'FULFILLMENTS_UPDATE', /** The webhook topic for `attributed_sessions/first` events. */ AttributedSessionsFirst = 'ATTRIBUTED_SESSIONS_FIRST', /** The webhook topic for `attributed_sessions/last` events. */ AttributedSessionsLast = 'ATTRIBUTED_SESSIONS_LAST', /** The webhook topic for `order_transactions/create` events. */ OrderTransactionsCreate = 'ORDER_TRANSACTIONS_CREATE', /** The webhook topic for `orders/cancelled` events. */ OrdersCancelled = 'ORDERS_CANCELLED', /** The webhook topic for `orders/create` events. */ OrdersCreate = 'ORDERS_CREATE', /** The webhook topic for `orders/delete` events. */ OrdersDelete = 'ORDERS_DELETE', /** The webhook topic for `orders/edited` events. */ OrdersEdited = 'ORDERS_EDITED', /** The webhook topic for `orders/fulfilled` events. */ OrdersFulfilled = 'ORDERS_FULFILLED', /** The webhook topic for `orders/paid` events. */ OrdersPaid = 'ORDERS_PAID', /** The webhook topic for `orders/partially_fulfilled` events. */ OrdersPartiallyFulfilled = 'ORDERS_PARTIALLY_FULFILLED', /** The webhook topic for `orders/updated` events. */ OrdersUpdated = 'ORDERS_UPDATED', /** The webhook topic for `product_listings/add` events. */ ProductListingsAdd = 'PRODUCT_LISTINGS_ADD', /** The webhook topic for `product_listings/remove` events. */ ProductListingsRemove = 'PRODUCT_LISTINGS_REMOVE', /** The webhook topic for `product_listings/update` events. */ ProductListingsUpdate = 'PRODUCT_LISTINGS_UPDATE', /** The webhook topic for `product_publications/create` events. */ ProductPublicationsCreate = 'PRODUCT_PUBLICATIONS_CREATE', /** The webhook topic for `product_publications/delete` events. */ ProductPublicationsDelete = 'PRODUCT_PUBLICATIONS_DELETE', /** The webhook topic for `product_publications/update` events. */ ProductPublicationsUpdate = 'PRODUCT_PUBLICATIONS_UPDATE', /** The webhook topic for `products/create` events. */ ProductsCreate = 'PRODUCTS_CREATE', /** The webhook topic for `products/delete` events. */ ProductsDelete = 'PRODUCTS_DELETE', /** The webhook topic for `products/update` events. */ ProductsUpdate = 'PRODUCTS_UPDATE', /** The webhook topic for `refunds/create` events. */ RefundsCreate = 'REFUNDS_CREATE', /** The webhook topic for `shipping_addresses/create` events. */ ShippingAddressesCreate = 'SHIPPING_ADDRESSES_CREATE', /** The webhook topic for `shipping_addresses/update` events. */ ShippingAddressesUpdate = 'SHIPPING_ADDRESSES_UPDATE', /** The webhook topic for `shop/update` events. */ ShopUpdate = 'SHOP_UPDATE', /** The webhook topic for `tax_services/create` events. */ TaxServicesCreate = 'TAX_SERVICES_CREATE', /** The webhook topic for `tax_services/update` events. */ TaxServicesUpdate = 'TAX_SERVICES_UPDATE', /** The webhook topic for `themes/create` events. */ ThemesCreate = 'THEMES_CREATE', /** The webhook topic for `themes/delete` events. */ ThemesDelete = 'THEMES_DELETE', /** The webhook topic for `themes/publish` events. */ ThemesPublish = 'THEMES_PUBLISH', /** The webhook topic for `themes/update` events. */ ThemesUpdate = 'THEMES_UPDATE', /** The webhook topic for `variants/in_stock` events. */ VariantsInStock = 'VARIANTS_IN_STOCK', /** The webhook topic for `variants/out_of_stock` events. */ VariantsOutOfStock = 'VARIANTS_OUT_OF_STOCK', /** The webhook topic for `inventory_levels/connect` events. */ InventoryLevelsConnect = 'INVENTORY_LEVELS_CONNECT', /** The webhook topic for `inventory_levels/update` events. */ InventoryLevelsUpdate = 'INVENTORY_LEVELS_UPDATE', /** The webhook topic for `inventory_levels/disconnect` events. */ InventoryLevelsDisconnect = 'INVENTORY_LEVELS_DISCONNECT', /** The webhook topic for `attribution/risk` events. */ AttributionRisk = 'ATTRIBUTION_RISK', /** The webhook topic for `inventory_items/create` events. */ InventoryItemsCreate = 'INVENTORY_ITEMS_CREATE', /** The webhook topic for `inventory_items/update` events. */ InventoryItemsUpdate = 'INVENTORY_ITEMS_UPDATE', /** The webhook topic for `inventory_items/delete` events. */ InventoryItemsDelete = 'INVENTORY_ITEMS_DELETE', /** The webhook topic for `locations/create` events. */ LocationsCreate = 'LOCATIONS_CREATE', /** The webhook topic for `locations/update` events. */ LocationsUpdate = 'LOCATIONS_UPDATE', /** The webhook topic for `locations/delete` events. */ LocationsDelete = 'LOCATIONS_DELETE', /** The webhook topic for `tender_transactions/create` events. */ TenderTransactionsCreate = 'TENDER_TRANSACTIONS_CREATE', /** The webhook topic for `app_purchases_one_time/update` events. */ AppPurchasesOneTimeUpdate = 'APP_PURCHASES_ONE_TIME_UPDATE', /** The webhook topic for `app_subscriptions/update` events. */ AppSubscriptionsUpdate = 'APP_SUBSCRIPTIONS_UPDATE', /** The webhook topic for `locales/create` events. */ LocalesCreate = 'LOCALES_CREATE', /** The webhook topic for `locales/update` events. */ LocalesUpdate = 'LOCALES_UPDATE', /** The webhook topic for `domains/create` events. */ DomainsCreate = 'DOMAINS_CREATE', /** The webhook topic for `domains/update` events. */ DomainsUpdate = 'DOMAINS_UPDATE', /** The webhook topic for `domains/destroy` events. */ DomainsDestroy = 'DOMAINS_DESTROY', /** The webhook topic for `subscription_contracts/create` events. */ SubscriptionContractsCreate = 'SUBSCRIPTION_CONTRACTS_CREATE', /** The webhook topic for `subscription_contracts/update` events. */ SubscriptionContractsUpdate = 'SUBSCRIPTION_CONTRACTS_UPDATE', /** The webhook topic for `profiles/create` events. */ ProfilesCreate = 'PROFILES_CREATE', /** The webhook topic for `profiles/update` events. */ ProfilesUpdate = 'PROFILES_UPDATE', /** The webhook topic for `profiles/delete` events. */ ProfilesDelete = 'PROFILES_DELETE', /** The webhook topic for `subscription_billing_attempts/success` events. */ SubscriptionBillingAttemptsSuccess = 'SUBSCRIPTION_BILLING_ATTEMPTS_SUCCESS', /** The webhook topic for `subscription_billing_attempts/failure` events. */ SubscriptionBillingAttemptsFailure = 'SUBSCRIPTION_BILLING_ATTEMPTS_FAILURE' } /** Return type for `webhookSubscriptionUpdate` mutation. */ export type WebhookSubscriptionUpdatePayload = { __typename?: 'WebhookSubscriptionUpdatePayload'; /** List of errors that occurred executing the mutation. */ userErrors: Array; /** The webhook subscription that was updated. */ webhookSubscription?: Maybe; }; /** Represents weight unit and value. */ export type Weight = { __typename?: 'Weight'; /** Unit of measurement for `value`. */ unit: WeightUnit; /** The weight using the unit system specified with `unit`. */ value: Scalars['Float']; }; /** Specifies the weight unit and value inputs. */ export type WeightInput = { /** The weight value using the unit system specified with `weight_unit`. */ value: Scalars['Float']; /** Unit of measurement for `value`. */ unit: WeightUnit; }; /** Units of measurement for weight. */ export enum WeightUnit { /** 1 kilogram equals 1000 grams. */ Kilograms = 'KILOGRAMS', /** Metric system unit of mass. */ Grams = 'GRAMS', /** 1 pound equals 16 ounces. */ Pounds = 'POUNDS', /** Imperial system unit of mass. */ Ounces = 'OUNCES' } /** Return type for `deliveryProfileCreate` mutation. */ export type DeliveryProfileCreatePayload = { __typename?: 'deliveryProfileCreatePayload'; /** The delivery profile that was created. */ profile?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `deliveryProfileRemove` mutation. */ export type DeliveryProfileRemovePayload = { __typename?: 'deliveryProfileRemovePayload'; /** The profile deletion job triggered by the mutation. */ job?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; /** Return type for `deliveryProfileUpdate` mutation. */ export type DeliveryProfileUpdatePayload = { __typename?: 'deliveryProfileUpdatePayload'; /** The delivery profile that was updated. */ profile?: Maybe; /** List of errors that occurred executing the mutation. */ userErrors: Array; }; export type CreateCollectionMutationVariables = Exact<{ input: CollectionInput; }>; export type CreateCollectionMutation = ( { __typename?: 'Mutation' } & { collectionCreate?: Maybe<( { __typename?: 'CollectionCreatePayload' } & { collection?: Maybe<( { __typename?: 'Collection' } & Pick )> } )> } ); export const CreateCollectionDocument = gql` mutation createCollection($input: CollectionInput!) { collectionCreate(input: $input) { collection { id title } } } `; export type SdkFunctionWrapper = (action: () => Promise) => Promise; const defaultWrapper: SdkFunctionWrapper = sdkFunction => sdkFunction(); export function getSdk(client: GraphQLClient, withWrapper: SdkFunctionWrapper = defaultWrapper) { return { createCollection(variables: CreateCollectionMutationVariables, requestHeaders?: Dom.RequestInit["headers"]): Promise { return withWrapper(() => client.request(CreateCollectionDocument, variables, requestHeaders)); } }; } export type Sdk = ReturnType;