/** * THIS FILE IS AUTO-GENERATED, DO NOT EDIT * Based on Customer Account API 2026-01 * If changes need to happen to the types defined in this file, then generally the Storefront API needs to update. After it's updated, you can run `npm run graphql-types`. * Except custom Scalars, which are defined in the `codegen.ts` file */ /* eslint-disable */ export type Maybe = T | null; export type InputMaybe = Maybe; export type Exact = {[K in keyof T]: T[K]}; export type MakeOptional = Omit & { [SubKey in K]?: Maybe; }; export type MakeMaybe = Omit & { [SubKey in K]: Maybe; }; export type MakeEmpty = { [_ in K]?: never; }; export type Incremental = | T | {[P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never}; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { ID: {input: string; output: string}; String: {input: string; output: string}; Boolean: {input: boolean; output: boolean}; Int: {input: number; output: number}; Float: {input: number; output: number}; DateTime: {input: string; output: string}; Decimal: {input: string; output: string}; HTML: {input: string; output: string}; ISO8601DateTime: {input: string; output: string}; JSON: {input: unknown; output: unknown}; URL: {input: string; output: string}; UnsignedInt64: {input: string; output: string}; }; /** The bank account payment details related to a transaction. */ export type AchPaymentDetails = { __typename?: 'AchPaymentDetails'; /** The name of the bank used. */ bankName: Scalars['String']['output']; /** The last four digits of the bank account used. */ last4?: Maybe; }; /** A sale that includes an additional fee charge. */ export type AdditionalFeeSale = Node & Sale & { __typename?: 'AdditionalFeeSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** The address form field. */ export type AddressFormField = { __typename?: 'AddressFormField'; /** The mode of the address field. */ mode: AddressFormFieldMode; }; /** Defines the mode for an address form field. */ export type AddressFormFieldMode = /** * Indicates that the form field should be hidden from the UI. * Any values provided by the client will be ignored by the backend. */ | 'IGNORED' /** Indicates that the form field is visible in the UI and can be left empty. */ | 'OPTIONAL' /** Indicates that the form field is visible in the UI and requires a non-empty value. */ | 'REQUIRED'; /** The settings for the address form. */ export type AddressFormSettings = { __typename?: 'AddressFormSettings'; /** The setting for the Address2 form field. */ address2: AddressFormField; /** Whether the address autocompletion is enabled. */ addressAutocompletion: Scalars['Boolean']['output']; /** The setting for the Company form field. */ company: AddressFormField; /** The setting for the First name form field. */ firstName: AddressFormField; /** The setting for the Phone form field. */ phone: AddressFormField; }; /** A sale event that results in an adjustment to the order price. */ export type AdjustmentSale = Node & Sale & { __typename?: 'AdjustmentSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** A Shopify app. */ export type App = Node & { __typename?: 'App'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The name of the app. */ title: Scalars['String']['output']; }; /** The input fields for the billing address received from Apple Pay. */ export type ApplePayBillingAddressInput = { /** The first line of the address, typically the street address or PO Box number. */ address1?: InputMaybe; /** The second line of the address, typically the apartment, suite, or unit number. */ address2?: InputMaybe; /** The region of the address, such as the province, state, or district. */ administrativeArea?: InputMaybe; /** The name of the country. */ country?: InputMaybe; /** The two-letter code for the country of the address. */ countryCode?: InputMaybe; /** The family name of the customer. */ familyName?: InputMaybe; /** The given name of the customer. */ givenName?: InputMaybe; /** The name of the city, district, village, or town. */ locality?: InputMaybe; /** The telephone number of the customer. */ phoneNumber?: InputMaybe; /** The zip or postal code of the address. */ postalCode?: InputMaybe; }; /** Return type for `applePayCreditCardAdd` mutation. */ export type ApplePayCreditCardAddPayload = { __typename?: 'ApplePayCreditCardAddPayload'; /** The newly added credit card. */ creditCard?: Maybe; /** If the card verification result is processing. When this is true, credit_card will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `applePayCreditCardUpdate` mutation. */ export type ApplePayCreditCardUpdatePayload = { __typename?: 'ApplePayCreditCardUpdatePayload'; /** The updated credit card. */ creditCard?: Maybe; /** If the card verification result is processing. When this is true, credit_card will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `applePaySessionCreate` mutation. */ export type ApplePaySessionCreatePayload = { __typename?: 'ApplePaySessionCreatePayload'; /** The object that contains the session data. */ body?: Maybe; /** The ID for the created session. */ id?: Maybe; /** Whether the session is ready. The `body` field is `null` while this value is `false`. */ ready?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The error codes for failures to create Apple Pay sessions. */ export type ApplePaySessionUserError = DisplayableError & { __typename?: 'ApplePaySessionUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `ApplePaySessionUserError`. */ export type ApplePaySessionUserErrorCode = /** Apple Pay session could not be created. */ | 'SESSION_COULD_NOT_BE_CREATED' /** Validation URL is not an Apple Pay gateway endpoint. */ | 'VALIDATION_URL_IS_INVALID'; /** The configuration settings for the Apple Pay wallet. */ export type ApplePayWalletConfig = { __typename?: 'ApplePayWalletConfig'; /** Supported card networks for Apple Pay. */ supportedNetworks: Array; }; /** The details about the gift card used on the checkout. */ export type AppliedGiftCard = Node & { __typename?: 'AppliedGiftCard'; /** The amount deducted from the gift card. */ amountUsed: MoneyV2; /** The remaining amount on the gift card. */ balance: MoneyV2; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The last characters of the gift card. */ lastCharacters: Scalars['String']['output']; /** The amount applied to the checkout in its currency. */ presentmentAmountUsed: MoneyV2; }; /** * A custom property. Attributes are used to store additional information about a Shopify resource, such as * products, customers, or orders. Attributes are stored as key-value pairs. * * For example, a list of attributes might include whether a customer is a first-time buyer (`"customer_first_order": "true"`), * whether an order is gift-wrapped (`"gift_wrapped": "true"`), a preferred delivery date * (`"preferred_delivery_date": "2025-10-01"`), the discount applied (`"loyalty_discount_applied": "10%"`), and any * notes provided by the customer (`"customer_notes": "Please leave at the front door"`). */ export type Attribute = { __typename?: 'Attribute'; /** The key or name of the attribute. For example, `"customer_first_order"`. */ key: Scalars['String']['output']; /** The value of the attribute. For example, `"true"`. */ value?: Maybe; }; /** Captures 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; /** The lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ title: Scalars['String']['output']; /** The value of the discount application. */ value: PricingValue; }; /** A collection of available shipping rates for a checkout. */ export type AvailableShippingRates = { __typename?: 'AvailableShippingRates'; /** * Whether the shipping rates are ready. * The `shippingRates` field is `null` when this value is `false`. * This field should be polled until its value becomes `true`. */ ready: Scalars['Boolean']['output']; /** The fetched shipping rates. `null` until the `ready` field is `true`. */ shippingRates?: Maybe>; }; /** The type of bank account holder. */ export type BankAccountHolderType = /** A company account holder. */ | 'COMPANY' /** An individual account holder. */ | 'INDIVIDUAL'; /** The type of bank account. */ export type BankAccountType = /** A checking account. */ | 'CHECKING' /** A savings account. */ | 'SAVINGS'; /** Represents a bank account payment instrument. */ export type BankPaymentInstrument = Node & PaymentInstrument & { __typename?: 'BankPaymentInstrument'; /** The type of account holder. */ accountHolderType?: Maybe; /** The type of bank account. */ accountType: BankAccountType; /** The name of the bank. */ bankName: Scalars['String']['output']; /** The billing address associated with the bank account. */ billingAddress?: Maybe; /** The list of open draft orders associated with this payment instrument. */ draftOrders: DraftOrderConnection; /** The globally-unique ID. */ id: Scalars['ID']['output']; /** The last four digits of the account number. */ lastDigits: Scalars['String']['output']; /** The list of pending orders associated with this payment instrument. */ orders: OrderConnection; /** The list of subscription contracts charged using this payment instrument. */ subscriptionContracts: SubscriptionContractConnection; }; /** Represents a bank account payment instrument. */ export type BankPaymentInstrumentDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents a bank account payment instrument. */ export type BankPaymentInstrumentOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents a bank account payment instrument. */ export type BankPaymentInstrumentSubscriptionContractsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** A bank payment method that can be used for recurring and future payments. */ export type BankPaymentMethod = { __typename?: 'BankPaymentMethod'; /** The payment provider client credentials. */ paymentProviderClientCredentials: PaymentProviderClientCredentials; }; /** The input fields required for updating a business contact. */ export type BusinessContactUpdateInput = { /** The first name of the business contact. */ firstName?: InputMaybe; /** The last name of the business contact. */ lastName?: InputMaybe; /** The locale of the business contact. */ locale?: InputMaybe; /** The title of the business contact. */ title?: InputMaybe; }; /** Return type for `businessContactUpdate` mutation. */ export type BusinessContactUpdatePayload = { __typename?: 'BusinessContactUpdatePayload'; /** The updated business contact information. */ businessContact?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Possible error codes that can be returned by `BusinessCustomerUserError`. */ export type BusinessCustomerErrorCode = /** The input value is blank. */ | 'BLANK' /** Business location doesn't exist. */ | 'BUSINESS_LOCATION_NOT_FOUND' /** Deleting the resource failed. */ | 'FAILED_TO_DELETE' /** An internal error occurred. */ | 'INTERNAL_ERROR' /** The input value is invalid. */ | 'INVALID' /** The input is invalid. */ | 'INVALID_INPUT' /** The number of resources exceeded the limit. */ | 'LIMIT_REACHED' /** The input is empty. */ | 'NO_INPUT' /** Permission denied. */ | 'PERMISSION_DENIED' /** Missing a required field. */ | 'REQUIRED' /** The resource wasn't found. */ | 'RESOURCE_NOT_FOUND' /** The input value is already taken. */ | 'TAKEN' /** The field value is too long. */ | 'TOO_LONG' /** Unexpected type. */ | 'UNEXPECTED_TYPE'; /** An error that happens during the execution of a business customer mutation. */ export type BusinessCustomerUserError = DisplayableError & { __typename?: 'BusinessCustomerUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Return type for `businessLocationCreditCardAdd` mutation. */ export type BusinessLocationCreditCardAddPayload = { __typename?: 'BusinessLocationCreditCardAddPayload'; /** The newly added credit card. */ creditCard?: Maybe; /** The URL to redirect the customer to for completing the 3D Secure payment flow. */ nextActionUrl?: Maybe; /** If the card verification result is processing. When this is true, credit_card will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `businessLocationCreditCardUpdate` mutation. */ export type BusinessLocationCreditCardUpdatePayload = { __typename?: 'BusinessLocationCreditCardUpdatePayload'; /** The updated credit card. */ creditCard?: Maybe; /** If the card verification result is processing. When this is true, credit_card will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `businessLocationPaymentInstrumentRemove` mutation. */ export type BusinessLocationPaymentInstrumentRemovePayload = { __typename?: 'BusinessLocationPaymentInstrumentRemovePayload'; /** The ID of the removed payment instrument. */ deletedPaymentInstrumentId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The configuration for the buyer's checkout. */ export type BuyerExperienceConfiguration = { __typename?: 'BuyerExperienceConfiguration'; /** The deposit amount required for the order. */ deposit?: Maybe; /** * Whether the buyer must pay at checkout or * can choose to pay at checkout or pay later using net terms. */ payNowOnly: Scalars['Boolean']['output']; /** The merchant configured payment terms. */ paymentTermsTemplate?: Maybe; }; /** The input fields to calculate return amounts associated with an order. */ export type CalculateReturnInput = { /** The ID of the order that will be returned. */ orderId: Scalars['ID']['input']; /** The line items from the order to include in the return. */ returnLineItems: Array; }; /** The input fields for return line items on a calculated return. */ export type CalculateReturnLineItemInput = { /** The ID of the line item to be returned. */ lineItemId: Scalars['ID']['input']; /** The quantity of the item to be returned.Quantity can't exceed the line item's fulfilled quantity. */ quantity: Scalars['Int']['input']; }; /** The calculated financial outcome of a return based on the line items requested for return.Includes the monetary values of the line items, along with applicable taxes, discounts, and otherfees on the order. Financial summary may include return fees depending onthe [return rules](https://help.shopify.com/manual/fulfillment/managing-orders/returns/return-rules)at the time the order was placed. */ export type CalculatedReturn = { __typename?: 'CalculatedReturn'; /** A breakdown of the monetary values for the calculated return. */ financialSummary: ReturnFinancialSummary; /** A list of line items being processed for a return. */ returnLineItems: CalculatedReturnLineItemConnection; }; /** The calculated financial outcome of a return based on the line items requested for return.Includes the monetary values of the line items, along with applicable taxes, discounts, and otherfees on the order. Financial summary may include return fees depending onthe [return rules](https://help.shopify.com/manual/fulfillment/managing-orders/returns/return-rules)at the time the order was placed. */ export type CalculatedReturnReturnLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The line item being processed for a return and its calculated monetary values. */ export type CalculatedReturnLineItem = { __typename?: 'CalculatedReturnLineItem'; /** The line item being processed for a return. */ lineItem: LineItem; /** The quantity being returned. */ quantity: Scalars['Int']['output']; /** The subtotal of the return line item without target all discounts. */ subtotalBeforeTargetAllDiscountsSet: MoneyBag; /** The subtotal of the return line item. */ subtotalSet: MoneyBag; /** The total tax of the return line item. */ totalTaxSet: MoneyBag; }; /** An auto-generated type for paginating through multiple CalculatedReturnLineItems. */ export type CalculatedReturnLineItemConnection = { __typename?: 'CalculatedReturnLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in CalculatedReturnLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CalculatedReturnLineItem and a cursor during pagination. */ export type CalculatedReturnLineItemEdge = { __typename?: 'CalculatedReturnLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of CalculatedReturnLineItemEdge. */ node: CalculatedReturnLineItem; }; /** The card payment details related to a transaction. */ export type CardPaymentDetails = { __typename?: 'CardPaymentDetails'; /** The brand of the credit card used. */ cardBrand: Scalars['String']['output']; /** The last four digits of the credit card used. */ last4?: Maybe; }; /** A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type Checkout = Node & { __typename?: 'Checkout'; /** The gift cards used on the checkout. */ appliedGiftCards: Array; /** * The available shipping rates for this Checkout. * Should only be used when checkout `requiresShipping` is `true` and * the shipping address is valid. */ availableShippingRates?: Maybe; /** The date and time when the checkout was created. */ createdAt: Scalars['DateTime']['output']; /** The currency code for the checkout. */ currencyCode: CurrencyCode; /** The extra information added to the checkout. */ customAttributes: Array; /** The discounts applied on the checkout. */ discountApplications: DiscountApplicationConnection; /** The email associated with this checkout. */ email?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** A list of line item objects, each containing information about an item in the checkout. */ lineItems: CheckoutLineItemConnection; /** * The sum of all the prices of all the items in the checkout, * excluding duties, taxes, shipping, and discounts. */ lineItemsSubtotalPrice: MoneyV2; /** The note associated with the checkout. */ note?: Maybe; /** The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards. */ paymentDue: MoneyV2; /** * Whether the Checkout is ready and can be completed. Checkouts may * have asynchronous operations that can take time to finish. If you want * to complete a checkout or ensure all the fields are populated and up to * date, polling is required until the value is true. */ ready: Scalars['Boolean']['output']; /** Whether the fulfillment requires shipping. */ requiresShipping: Scalars['Boolean']['output']; /** The address where the line items will be shipped. */ shippingAddress?: Maybe; /** The discounts allocated to the shipping line by discount applications. */ shippingDiscountAllocations: Array; /** The selected shipping rate, transitioned to a `shipping_line` object. */ shippingLine?: Maybe; /** The price at checkout before duties, shipping, and taxes. */ subtotalPrice: MoneyV2; /** Whether the checkout is tax exempt. */ taxExempt: Scalars['Boolean']['output']; /** Whether taxes are included in the line item and shipping line prices. */ taxesIncluded: Scalars['Boolean']['output']; /** The sum of all the duties applied to the line items in the checkout. */ totalDuties?: Maybe; /** * The sum of all the prices of all the items in the checkout, * duties, taxes, and discounts included. */ totalPrice: MoneyV2; /** The sum of all the taxes applied to the line items and shipping lines in the checkout. */ totalTax: MoneyV2; /** The URL for the checkout, accessible from the web. */ webUrl: Scalars['URL']['output']; }; /** A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CheckoutDiscountApplicationsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CheckoutLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A line item in the checkout, grouped by variant and attributes. */ export type CheckoutLineItem = Node & { __typename?: 'CheckoutLineItem'; /** An array of Key-Value pairs providing extra information about the line item. */ customAttributes: Array; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The price of the line item. */ price?: Maybe; /** The quantity of the line item. */ quantity: Scalars['Int']['output']; /** The title of the line item. Defaults to the product's title. */ title: Scalars['String']['output']; /** The unit price of the line item. */ unitPrice?: Maybe; /** The name of the variant. */ variantTitle?: Maybe; }; /** An auto-generated type for paginating through multiple CheckoutLineItems. */ export type CheckoutLineItemConnection = { __typename?: 'CheckoutLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in CheckoutLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. */ export type CheckoutLineItemEdge = { __typename?: 'CheckoutLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of CheckoutLineItemEdge. */ node: CheckoutLineItem; }; /** Represents a company's information. */ export type Company = HasMetafields & Node & { __typename?: 'Company'; /** The list of company draft orders. */ draftOrders: DraftOrderConnection; /** A unique externally-supplied ID for the company. */ externalId?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The list of locations that the business of the business contact belongs to. */ locations: CompanyLocationConnection; /** A metafield found by namespace and key. */ metafield?: Maybe; /** * The metafields associated with the resource matching the * supplied list of namespaces and keys. */ metafields: Array>; /** The name of the company. */ name: Scalars['String']['output']; /** The list of customer orders under the company. */ orders: OrderConnection; /** The profile of the customer. */ profile?: Maybe; }; /** Represents a company's information. */ export type CompanyDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents a company's information. */ export type CompanyLocationsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents a company's information. */ export type CompanyMetafieldArgs = { key: Scalars['String']['input']; namespace: Scalars['String']['input']; }; /** Represents a company's information. */ export type CompanyMetafieldsArgs = { identifiers: Array; }; /** Represents a company's information. */ export type CompanyOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CompanyAddress = Node & { __typename?: 'CompanyAddress'; /** The first line of the address. It is typically the street address or PO Box number. */ address1: Scalars['String']['output']; /** The second line of the address. It is typically the apartment, suite, or unit number. */ address2?: Maybe; /** The city, district, village, or town. */ city?: Maybe; /** The name of the company. */ company: Scalars['String']['output']; /** The name of the company. */ companyName: Scalars['String']['output']; /** The name of the country of the address. */ country?: Maybe; /** The two-letter code for the country of the address, for example, US. */ countryCode: CountryCode; /** The two-letter code for the country of the address, for example, US. */ countryCodeV2: CountryCode; /** * The date and time (in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) * when the company address was created. */ createdAt: Scalars['DateTime']['output']; /** The first name of the recipient. */ firstName?: Maybe; /** The formatted version of the address. */ formatted: Array; /** The formatted version of the address. */ formattedAddress: Array; /** A comma-separated list of the city, province, and country values. */ formattedArea?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The last name of the recipient. */ lastName?: Maybe; /** The latitude coordinate of the address. */ latitude?: Maybe; /** The longitude coordinate of the address. */ longitude?: Maybe; /** The unique phone number of the customer, formatted using the E.164 standard, for example, _+16135551111_. */ phone?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** The alphanumeric code for the region, for example, ON. */ provinceCode?: Maybe; /** The identity of the recipient, for example, 'Receiving Department'. */ recipient?: Maybe; /** * The date and time (in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) * when the company address was last updated. */ updatedAt: Scalars['DateTime']['output']; /** The zip or postal code of the address. */ zip?: Maybe; /** The alphanumeric code for the region, for example, ON. */ zoneCode?: Maybe; }; /** The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CompanyAddressFormattedArgs = { withCompanyName?: InputMaybe; withName?: InputMaybe; }; /** The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CompanyAddressFormattedAddressArgs = { withCompanyName?: InputMaybe; withName?: InputMaybe; }; /** The input fields for creating or updating a company location address. */ export type CompanyAddressInput = { /** The first line of the address, typically the street address or PO Box number. */ address1?: InputMaybe; /** The second line of the address, typically the number of the apartment, suite, or unit. */ address2?: InputMaybe; /** The name of the city, district, village, or town. */ city?: InputMaybe; /** The two-letter code for the country of the address. */ countryCode?: InputMaybe; /** The first name in the address. */ firstName?: InputMaybe; /** The last name in the address. */ lastName?: InputMaybe; /** A unique phone number for the business location, formatted using the E.164 standard, for example, _+16135551111_. */ phone?: InputMaybe; /** The identity of the recipient, for example, 'Receiving Department'. */ recipient?: InputMaybe; /** The zip or postal code of the address. */ zip?: InputMaybe; /** The code for the region of the address, such as the province, state, or district, for example, QC for Quebec, Canada. */ zoneCode?: InputMaybe; }; /** The valid values for the address type of a company. */ export type CompanyAddressType = /** The address is a billing address. */ | 'BILLING' /** The address is a shipping address. */ | 'SHIPPING'; /** Represents the customer's contact information. */ export type CompanyContact = Node & { __typename?: 'CompanyContact'; /** The information of the copmany contact's company. */ company?: Maybe; /** The customer associated to this contact. */ customer: Customer; /** The list of company contact's draft orders. */ draftOrders: DraftOrderConnection; /** Whether the company contact has permissions on locations in the scope. */ hasPermissionOnLocations: Scalars['Boolean']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The list of locations that the company contact belongs to. */ locations: CompanyLocationConnection; /** The list of company contact's orders. */ orders: OrderConnection; /** The current status of the company contact. */ status: CompanyContactStatusType; /** The list of tax exemptions applied to the company contact with additional details. */ taxExemptionsDetails: Array; /** The job title of the company contact. */ title?: Maybe; }; /** Represents the customer's contact information. */ export type CompanyContactDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents the customer's contact information. */ export type CompanyContactHasPermissionOnLocationsArgs = { permissions: Array; resource: ResourceType; scope: ContactPermissionLocationScopeType; }; /** Represents the customer's contact information. */ export type CompanyContactLocationsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents the customer's contact information. */ export type CompanyContactOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** An auto-generated type for paginating through multiple CompanyContacts. */ export type CompanyContactConnection = { __typename?: 'CompanyContactConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in CompanyContactEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CompanyContact and a cursor during pagination. */ export type CompanyContactEdge = { __typename?: 'CompanyContactEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of CompanyContactEdge. */ node: CompanyContact; }; /** A role for a company contact. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CompanyContactRole = Node & { __typename?: 'CompanyContactRole'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The name of the role. */ name: Scalars['String']['output']; /** The permissions on a specified resource. */ resourcePermission: Array; /** A list of permissions on all resources. */ resourcePermissions: Array; }; /** A role for a company contact. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CompanyContactRoleResourcePermissionArgs = { resource: ResourceType; }; /** Represents information about a company contact role assignment. */ export type CompanyContactRoleAssignment = Node & { __typename?: 'CompanyContactRoleAssignment'; /** The company contact for whom this role is assigned. */ contact: CompanyContact; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The role that's assigned. */ role: CompanyContactRole; }; /** An auto-generated type for paginating through multiple CompanyContactRoleAssignments. */ export type CompanyContactRoleAssignmentConnection = { __typename?: 'CompanyContactRoleAssignmentConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in CompanyContactRoleAssignmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CompanyContactRoleAssignment and a cursor during pagination. */ export type CompanyContactRoleAssignmentEdge = { __typename?: 'CompanyContactRoleAssignmentEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of CompanyContactRoleAssignmentEdge. */ node: CompanyContactRoleAssignment; }; /** The set of valid sort keys for the CompanyContactRoleAssignment query. */ export type CompanyContactRoleAssignmentSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID' /** Sort by the `location_name` value. */ | 'LOCATION_NAME' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** The set of valid sort keys for the CompanyContact query. */ export type CompanyContactSortKeys = /** Sort by the `company_id` value. */ | 'COMPANY_ID' /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `email` value. */ | 'EMAIL' /** Sort by the `id` value. */ | 'ID' /** Sort by the `name` value. */ | 'NAME' /** Sort by the `name_email` value. */ | 'NAME_EMAIL' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. */ | 'RELEVANCE' /** Sort by the `title` value. */ | 'TITLE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** A flag to describe the current status of a company contact. */ export type CompanyContactStatusType = /** The contact is disabled and removed from the company. */ | 'DISABLED' /** The contact is enabled and active. */ | 'ENABLED'; /** Represents a company's business location. */ export type CompanyLocation = HasMetafields & HasStoreCreditAccounts & Node & { __typename?: 'CompanyLocation'; /** The list of all available payment methods that can be used for recurring and future payments. */ availablePaymentMethods: Array; /** The billing address of the company location. */ billingAddress?: Maybe; /** The configuration of the buyer's B2B checkout. */ buyerExperienceConfiguration?: Maybe; /** The list of contacts under a particular business location. */ contacts: CompanyContactConnection; /** The credit card corresponding to the provided ID. */ creditCard?: Maybe; /** The list of stored credit cards. */ creditCards: CustomerCreditCardConnection; /** The list of company draft orders. */ draftOrders: DraftOrderConnection; /** A unique externally-supplied ID for the location. */ externalId?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** * The market that includes the location's shipping address. If the shipping address is empty, the shop's primary market is returned. * @deprecated This `market` field will be removed in a future version of the API. */ market: Market; /** A metafield found by namespace and key. */ metafield?: Maybe; /** * The metafields associated with the resource matching the * supplied list of namespaces and keys. */ metafields: Array>; /** The name of the company location. */ name: Scalars['String']['output']; /** The list of customer orders under the company. */ orders: OrderConnection; /** The payment instrument corresponding to the provided ID. */ paymentInstrument?: Maybe< BankPaymentInstrument | CustomerCreditCard | PaypalBillingAgreement >; /** The list of stored payment instruments. */ paymentInstruments: PaymentInstrumentConnection; /** The list of roles assigned to this location. */ roleAssignments: CompanyContactRoleAssignmentConnection; /** The shipping address of the company location. */ shippingAddress?: Maybe; /** A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout. */ storeCreditAccounts: StoreCreditAccountConnection; /** The list of tax exemptions applied to the location. */ taxExemptions: Array; /** The list of tax exemptions applied to the location with additional details. */ taxExemptionsDetails: Array; /** The tax id of the company location. */ taxIdentifier?: Maybe; }; /** Represents a company's business location. */ export type CompanyLocationContactsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents a company's business location. */ export type CompanyLocationCreditCardArgs = { id: Scalars['ID']['input']; }; /** Represents a company's business location. */ export type CompanyLocationCreditCardsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents a company's business location. */ export type CompanyLocationDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents a company's business location. */ export type CompanyLocationMetafieldArgs = { key: Scalars['String']['input']; namespace: Scalars['String']['input']; }; /** Represents a company's business location. */ export type CompanyLocationMetafieldsArgs = { identifiers: Array; }; /** Represents a company's business location. */ export type CompanyLocationOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents a company's business location. */ export type CompanyLocationPaymentInstrumentArgs = { id: Scalars['ID']['input']; }; /** Represents a company's business location. */ export type CompanyLocationPaymentInstrumentsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents a company's business location. */ export type CompanyLocationRoleAssignmentsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents a company's business location. */ export type CompanyLocationStoreCreditAccountsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; }; /** Return type for `companyLocationAssignAddress` mutation. */ export type CompanyLocationAssignAddressPayload = { __typename?: 'CompanyLocationAssignAddressPayload'; /** The list of updated addresses on the company location. */ addresses?: Maybe>; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple CompanyLocations. */ export type CompanyLocationConnection = { __typename?: 'CompanyLocationConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in CompanyLocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CompanyLocation and a cursor during pagination. */ export type CompanyLocationEdge = { __typename?: 'CompanyLocationEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of CompanyLocationEdge. */ node: CompanyLocation; }; /** The set of valid sort keys for the CompanyLocation query. */ export type CompanyLocationSortKeys = /** Sort by the `company_and_location_name` value. */ | 'COMPANY_AND_LOCATION_NAME' /** Sort by the `company_id` value. */ | 'COMPANY_ID' /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID' /** Sort by the `name` value. */ | 'NAME' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. */ | 'RELEVANCE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** Defines the extent of locations for which a contact holds permissions on a resource. */ export type ContactPermissionLocationScopeType = /** The contact has permission on all locations. */ | 'ALL' /** The contact has permission for at least one location. */ | 'ANY' /** The contact has no permission on any location. */ | 'NONE' /** The contact has permission on only one location. */ | 'ONE'; /** A numeric count with precision information indicating whether the count is exact or an estimate. */ export type Count = { __typename?: 'Count'; /** The count of elements. */ count: Scalars['Int']['output']; /** The count's precision, or the exactness of the value. */ precision: CountPrecision; }; /** The precision of the value returned by a count field. */ export type CountPrecision = /** The count is at least the value. A limit was imposed and reached. */ | 'AT_LEAST' /** The count is exactly the value. A write may not be reflected instantaneously. */ | 'EXACT'; /** * The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines. * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision * of another country. For example, the territories associated with Spain are represented by the country code `ES`, * and the territories associated with the United States of America are represented by the country code `US`. */ export type CountryCode = /** Ascension Island. */ | 'AC' /** Andorra. */ | 'AD' /** United Arab Emirates. */ | 'AE' /** Afghanistan. */ | 'AF' /** Antigua & Barbuda. */ | 'AG' /** Anguilla. */ | 'AI' /** Albania. */ | 'AL' /** Armenia. */ | 'AM' /** Netherlands Antilles. */ | 'AN' /** Angola. */ | 'AO' /** Argentina. */ | 'AR' /** Austria. */ | 'AT' /** Australia. */ | 'AU' /** Aruba. */ | 'AW' /** Åland Islands. */ | 'AX' /** Azerbaijan. */ | 'AZ' /** Bosnia & Herzegovina. */ | 'BA' /** Barbados. */ | 'BB' /** Bangladesh. */ | 'BD' /** Belgium. */ | 'BE' /** Burkina Faso. */ | 'BF' /** Bulgaria. */ | 'BG' /** Bahrain. */ | 'BH' /** Burundi. */ | 'BI' /** Benin. */ | 'BJ' /** St. Barthélemy. */ | 'BL' /** Bermuda. */ | 'BM' /** Brunei. */ | 'BN' /** Bolivia. */ | 'BO' /** Caribbean Netherlands. */ | 'BQ' /** Brazil. */ | 'BR' /** Bahamas. */ | 'BS' /** Bhutan. */ | 'BT' /** Bouvet Island. */ | 'BV' /** Botswana. */ | 'BW' /** Belarus. */ | 'BY' /** Belize. */ | 'BZ' /** Canada. */ | 'CA' /** Cocos (Keeling) Islands. */ | 'CC' /** Congo - Kinshasa. */ | 'CD' /** Central African Republic. */ | 'CF' /** Congo - Brazzaville. */ | 'CG' /** Switzerland. */ | 'CH' /** Côte d’Ivoire. */ | 'CI' /** Cook Islands. */ | 'CK' /** Chile. */ | 'CL' /** Cameroon. */ | 'CM' /** China. */ | 'CN' /** Colombia. */ | 'CO' /** Costa Rica. */ | 'CR' /** Cuba. */ | 'CU' /** Cape Verde. */ | 'CV' /** Curaçao. */ | 'CW' /** Christmas Island. */ | 'CX' /** Cyprus. */ | 'CY' /** Czechia. */ | 'CZ' /** Germany. */ | 'DE' /** Djibouti. */ | 'DJ' /** Denmark. */ | 'DK' /** Dominica. */ | 'DM' /** Dominican Republic. */ | 'DO' /** Algeria. */ | 'DZ' /** Ecuador. */ | 'EC' /** Estonia. */ | 'EE' /** Egypt. */ | 'EG' /** Western Sahara. */ | 'EH' /** Eritrea. */ | 'ER' /** Spain. */ | 'ES' /** Ethiopia. */ | 'ET' /** Finland. */ | 'FI' /** Fiji. */ | 'FJ' /** Falkland Islands. */ | 'FK' /** Faroe Islands. */ | 'FO' /** France. */ | 'FR' /** Gabon. */ | 'GA' /** United Kingdom. */ | 'GB' /** Grenada. */ | 'GD' /** Georgia. */ | 'GE' /** French Guiana. */ | 'GF' /** Guernsey. */ | 'GG' /** Ghana. */ | 'GH' /** Gibraltar. */ | 'GI' /** Greenland. */ | 'GL' /** Gambia. */ | 'GM' /** Guinea. */ | 'GN' /** Guadeloupe. */ | 'GP' /** Equatorial Guinea. */ | 'GQ' /** Greece. */ | 'GR' /** South Georgia & South Sandwich Islands. */ | 'GS' /** Guatemala. */ | 'GT' /** Guinea-Bissau. */ | 'GW' /** Guyana. */ | 'GY' /** Hong Kong SAR. */ | 'HK' /** Heard & McDonald Islands. */ | 'HM' /** Honduras. */ | 'HN' /** Croatia. */ | 'HR' /** Haiti. */ | 'HT' /** Hungary. */ | 'HU' /** Indonesia. */ | 'ID' /** Ireland. */ | 'IE' /** Israel. */ | 'IL' /** Isle of Man. */ | 'IM' /** India. */ | 'IN' /** British Indian Ocean Territory. */ | 'IO' /** Iraq. */ | 'IQ' /** Iran. */ | 'IR' /** Iceland. */ | 'IS' /** Italy. */ | 'IT' /** Jersey. */ | 'JE' /** Jamaica. */ | 'JM' /** Jordan. */ | 'JO' /** Japan. */ | 'JP' /** Kenya. */ | 'KE' /** Kyrgyzstan. */ | 'KG' /** Cambodia. */ | 'KH' /** Kiribati. */ | 'KI' /** Comoros. */ | 'KM' /** St. Kitts & Nevis. */ | 'KN' /** North Korea. */ | 'KP' /** South Korea. */ | 'KR' /** Kuwait. */ | 'KW' /** Cayman Islands. */ | 'KY' /** Kazakhstan. */ | 'KZ' /** Laos. */ | 'LA' /** Lebanon. */ | 'LB' /** St. Lucia. */ | 'LC' /** Liechtenstein. */ | 'LI' /** Sri Lanka. */ | 'LK' /** Liberia. */ | 'LR' /** Lesotho. */ | 'LS' /** Lithuania. */ | 'LT' /** Luxembourg. */ | 'LU' /** Latvia. */ | 'LV' /** Libya. */ | 'LY' /** Morocco. */ | 'MA' /** Monaco. */ | 'MC' /** Moldova. */ | 'MD' /** Montenegro. */ | 'ME' /** St. Martin. */ | 'MF' /** Madagascar. */ | 'MG' /** North Macedonia. */ | 'MK' /** Mali. */ | 'ML' /** Myanmar (Burma). */ | 'MM' /** Mongolia. */ | 'MN' /** Macao SAR. */ | 'MO' /** Martinique. */ | 'MQ' /** Mauritania. */ | 'MR' /** Montserrat. */ | 'MS' /** Malta. */ | 'MT' /** Mauritius. */ | 'MU' /** Maldives. */ | 'MV' /** Malawi. */ | 'MW' /** Mexico. */ | 'MX' /** Malaysia. */ | 'MY' /** Mozambique. */ | 'MZ' /** Namibia. */ | 'NA' /** New Caledonia. */ | 'NC' /** Niger. */ | 'NE' /** Norfolk Island. */ | 'NF' /** Nigeria. */ | 'NG' /** Nicaragua. */ | 'NI' /** Netherlands. */ | 'NL' /** Norway. */ | 'NO' /** Nepal. */ | 'NP' /** Nauru. */ | 'NR' /** Niue. */ | 'NU' /** New Zealand. */ | 'NZ' /** Oman. */ | 'OM' /** Panama. */ | 'PA' /** Peru. */ | 'PE' /** French Polynesia. */ | 'PF' /** Papua New Guinea. */ | 'PG' /** Philippines. */ | 'PH' /** Pakistan. */ | 'PK' /** Poland. */ | 'PL' /** St. Pierre & Miquelon. */ | 'PM' /** Pitcairn Islands. */ | 'PN' /** Palestinian Territories. */ | 'PS' /** Portugal. */ | 'PT' /** Paraguay. */ | 'PY' /** Qatar. */ | 'QA' /** Réunion. */ | 'RE' /** Romania. */ | 'RO' /** Serbia. */ | 'RS' /** Russia. */ | 'RU' /** Rwanda. */ | 'RW' /** Saudi Arabia. */ | 'SA' /** Solomon Islands. */ | 'SB' /** Seychelles. */ | 'SC' /** Sudan. */ | 'SD' /** Sweden. */ | 'SE' /** Singapore. */ | 'SG' /** St. Helena. */ | 'SH' /** Slovenia. */ | 'SI' /** Svalbard & Jan Mayen. */ | 'SJ' /** Slovakia. */ | 'SK' /** Sierra Leone. */ | 'SL' /** San Marino. */ | 'SM' /** Senegal. */ | 'SN' /** Somalia. */ | 'SO' /** Suriname. */ | 'SR' /** South Sudan. */ | 'SS' /** São Tomé & Príncipe. */ | 'ST' /** El Salvador. */ | 'SV' /** Sint Maarten. */ | 'SX' /** Syria. */ | 'SY' /** Eswatini. */ | 'SZ' /** Tristan da Cunha. */ | 'TA' /** Turks & Caicos Islands. */ | 'TC' /** Chad. */ | 'TD' /** French Southern Territories. */ | 'TF' /** Togo. */ | 'TG' /** Thailand. */ | 'TH' /** Tajikistan. */ | 'TJ' /** Tokelau. */ | 'TK' /** Timor-Leste. */ | 'TL' /** Turkmenistan. */ | 'TM' /** Tunisia. */ | 'TN' /** Tonga. */ | 'TO' /** Türkiye. */ | 'TR' /** Trinidad & Tobago. */ | 'TT' /** Tuvalu. */ | 'TV' /** Taiwan. */ | 'TW' /** Tanzania. */ | 'TZ' /** Ukraine. */ | 'UA' /** Uganda. */ | 'UG' /** U.S. Outlying Islands. */ | 'UM' /** United States. */ | 'US' /** Uruguay. */ | 'UY' /** Uzbekistan. */ | 'UZ' /** Vatican City. */ | 'VA' /** St. Vincent & Grenadines. */ | 'VC' /** Venezuela. */ | 'VE' /** British Virgin Islands. */ | 'VG' /** Vietnam. */ | 'VN' /** Vanuatu. */ | 'VU' /** Wallis & Futuna. */ | 'WF' /** Samoa. */ | 'WS' /** Kosovo. */ | 'XK' /** Yemen. */ | 'YE' /** Mayotte. */ | 'YT' /** South Africa. */ | 'ZA' /** Zambia. */ | 'ZM' /** Zimbabwe. */ | 'ZW' /** Unknown Region. */ | 'ZZ'; /** Return type for `creditCardAdd` mutation. */ export type CreditCardAddPayload = { __typename?: 'CreditCardAddPayload'; /** The newly added credit card. */ creditCard?: Maybe; /** The URL to which the customer should be redirected to complete the 3D Secure payment flow. */ nextActionUrl?: Maybe; /** If the card verification result is processing. When this is true, credit_card will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `creditCardUpdate` mutation. */ export type CreditCardUpdatePayload = { __typename?: 'CreditCardUpdatePayload'; /** The updated credit card. */ creditCard?: Maybe; /** If the card verification result is processing. When this is true, `credit_card` will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The part of the image that should remain after cropping. */ export type CropRegion = /** Keep the bottom of the image. */ | 'BOTTOM' /** Keep the center of the image. */ | 'CENTER' /** Keep the left of the image. */ | 'LEFT' /** Keep the right of the image. */ | 'RIGHT' /** Keep the top of the image. */ | 'TOP'; /** * The currency codes that represent the world currencies throughout the Admin API. Currency codes include * [standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, non-standard codes, * digital currency codes. */ export type CurrencyCode = /** United Arab Emirates Dirham (AED). */ | 'AED' /** Afghan Afghani (AFN). */ | 'AFN' /** Albanian Lek (ALL). */ | 'ALL' /** Armenian Dram (AMD). */ | 'AMD' /** Netherlands Antillean Guilder. */ | 'ANG' /** Angolan Kwanza (AOA). */ | 'AOA' /** Argentine Pesos (ARS). */ | 'ARS' /** Australian Dollars (AUD). */ | 'AUD' /** Aruban Florin (AWG). */ | 'AWG' /** Azerbaijani Manat (AZN). */ | 'AZN' /** Bosnia and Herzegovina Convertible Mark (BAM). */ | 'BAM' /** Barbadian Dollar (BBD). */ | 'BBD' /** Bangladesh Taka (BDT). */ | 'BDT' /** Bulgarian Lev (BGN). */ | 'BGN' /** Bahraini Dinar (BHD). */ | 'BHD' /** Burundian Franc (BIF). */ | 'BIF' /** Bermudian Dollar (BMD). */ | 'BMD' /** Brunei Dollar (BND). */ | 'BND' /** Bolivian Boliviano (BOB). */ | 'BOB' /** Brazilian Real (BRL). */ | 'BRL' /** Bahamian Dollar (BSD). */ | 'BSD' /** Bhutanese Ngultrum (BTN). */ | 'BTN' /** Botswana Pula (BWP). */ | 'BWP' /** Belarusian Ruble (BYN). */ | 'BYN' /** Belarusian Ruble (BYR). */ | 'BYR' /** Belize Dollar (BZD). */ | 'BZD' /** Canadian Dollars (CAD). */ | 'CAD' /** Congolese franc (CDF). */ | 'CDF' /** Swiss Francs (CHF). */ | 'CHF' /** Chilean Peso (CLP). */ | 'CLP' /** Chinese Yuan Renminbi (CNY). */ | 'CNY' /** Colombian Peso (COP). */ | 'COP' /** Costa Rican Colones (CRC). */ | 'CRC' /** Cape Verdean escudo (CVE). */ | 'CVE' /** Czech Koruny (CZK). */ | 'CZK' /** Djiboutian Franc (DJF). */ | 'DJF' /** Danish Kroner (DKK). */ | 'DKK' /** Dominican Peso (DOP). */ | 'DOP' /** Algerian Dinar (DZD). */ | 'DZD' /** Egyptian Pound (EGP). */ | 'EGP' /** Eritrean Nakfa (ERN). */ | 'ERN' /** Ethiopian Birr (ETB). */ | 'ETB' /** Euro (EUR). */ | 'EUR' /** Fijian Dollars (FJD). */ | 'FJD' /** Falkland Islands Pounds (FKP). */ | 'FKP' /** United Kingdom Pounds (GBP). */ | 'GBP' /** Georgian Lari (GEL). */ | 'GEL' /** Ghanaian Cedi (GHS). */ | 'GHS' /** Gibraltar Pounds (GIP). */ | 'GIP' /** Gambian Dalasi (GMD). */ | 'GMD' /** Guinean Franc (GNF). */ | 'GNF' /** Guatemalan Quetzal (GTQ). */ | 'GTQ' /** Guyanese Dollar (GYD). */ | 'GYD' /** Hong Kong Dollars (HKD). */ | 'HKD' /** Honduran Lempira (HNL). */ | 'HNL' /** Croatian Kuna (HRK). */ | 'HRK' /** Haitian Gourde (HTG). */ | 'HTG' /** Hungarian Forint (HUF). */ | 'HUF' /** Indonesian Rupiah (IDR). */ | 'IDR' /** Israeli New Shekel (NIS). */ | 'ILS' /** Indian Rupees (INR). */ | 'INR' /** Iraqi Dinar (IQD). */ | 'IQD' /** Iranian Rial (IRR). */ | 'IRR' /** Icelandic Kronur (ISK). */ | 'ISK' /** Jersey Pound. */ | 'JEP' /** Jamaican Dollars (JMD). */ | 'JMD' /** Jordanian Dinar (JOD). */ | 'JOD' /** Japanese Yen (JPY). */ | 'JPY' /** Kenyan Shilling (KES). */ | 'KES' /** Kyrgyzstani Som (KGS). */ | 'KGS' /** Cambodian Riel. */ | 'KHR' /** Kiribati Dollar (KID). */ | 'KID' /** Comorian Franc (KMF). */ | 'KMF' /** South Korean Won (KRW). */ | 'KRW' /** Kuwaiti Dinar (KWD). */ | 'KWD' /** Cayman Dollars (KYD). */ | 'KYD' /** Kazakhstani Tenge (KZT). */ | 'KZT' /** Laotian Kip (LAK). */ | 'LAK' /** Lebanese Pounds (LBP). */ | 'LBP' /** Sri Lankan Rupees (LKR). */ | 'LKR' /** Liberian Dollar (LRD). */ | 'LRD' /** Lesotho Loti (LSL). */ | 'LSL' /** Lithuanian Litai (LTL). */ | 'LTL' /** Latvian Lati (LVL). */ | 'LVL' /** Libyan Dinar (LYD). */ | 'LYD' /** Moroccan Dirham. */ | 'MAD' /** Moldovan Leu (MDL). */ | 'MDL' /** Malagasy Ariary (MGA). */ | 'MGA' /** Macedonia Denar (MKD). */ | 'MKD' /** Burmese Kyat (MMK). */ | 'MMK' /** Mongolian Tugrik. */ | 'MNT' /** Macanese Pataca (MOP). */ | 'MOP' /** Mauritanian Ouguiya (MRU). */ | 'MRU' /** Mauritian Rupee (MUR). */ | 'MUR' /** Maldivian Rufiyaa (MVR). */ | 'MVR' /** Malawian Kwacha (MWK). */ | 'MWK' /** Mexican Pesos (MXN). */ | 'MXN' /** Malaysian Ringgits (MYR). */ | 'MYR' /** Mozambican Metical. */ | 'MZN' /** Namibian Dollar. */ | 'NAD' /** Nigerian Naira (NGN). */ | 'NGN' /** Nicaraguan Córdoba (NIO). */ | 'NIO' /** Norwegian Kroner (NOK). */ | 'NOK' /** Nepalese Rupee (NPR). */ | 'NPR' /** New Zealand Dollars (NZD). */ | 'NZD' /** Omani Rial (OMR). */ | 'OMR' /** Panamian Balboa (PAB). */ | 'PAB' /** Peruvian Nuevo Sol (PEN). */ | 'PEN' /** Papua New Guinean Kina (PGK). */ | 'PGK' /** Philippine Peso (PHP). */ | 'PHP' /** Pakistani Rupee (PKR). */ | 'PKR' /** Polish Zlotych (PLN). */ | 'PLN' /** Paraguayan Guarani (PYG). */ | 'PYG' /** Qatari Rial (QAR). */ | 'QAR' /** Romanian Lei (RON). */ | 'RON' /** Serbian dinar (RSD). */ | 'RSD' /** Russian Rubles (RUB). */ | 'RUB' /** Rwandan Franc (RWF). */ | 'RWF' /** Saudi Riyal (SAR). */ | 'SAR' /** Solomon Islands Dollar (SBD). */ | 'SBD' /** Seychellois Rupee (SCR). */ | 'SCR' /** Sudanese Pound (SDG). */ | 'SDG' /** Swedish Kronor (SEK). */ | 'SEK' /** Singapore Dollars (SGD). */ | 'SGD' /** Saint Helena Pounds (SHP). */ | 'SHP' /** Sierra Leonean Leone (SLL). */ | 'SLL' /** Somali Shilling (SOS). */ | 'SOS' /** Surinamese Dollar (SRD). */ | 'SRD' /** South Sudanese Pound (SSP). */ | 'SSP' /** Sao Tome And Principe Dobra (STD). */ | 'STD' /** Sao Tome And Principe Dobra (STN). */ | 'STN' /** Syrian Pound (SYP). */ | 'SYP' /** Swazi Lilangeni (SZL). */ | 'SZL' /** Thai baht (THB). */ | 'THB' /** Tajikistani Somoni (TJS). */ | 'TJS' /** Turkmenistani Manat (TMT). */ | 'TMT' /** Tunisian Dinar (TND). */ | 'TND' /** Tongan Pa'anga (TOP). */ | 'TOP' /** Turkish Lira (TRY). */ | 'TRY' /** Trinidad and Tobago Dollars (TTD). */ | 'TTD' /** Taiwan Dollars (TWD). */ | 'TWD' /** Tanzanian Shilling (TZS). */ | 'TZS' /** Ukrainian Hryvnia (UAH). */ | 'UAH' /** Ugandan Shilling (UGX). */ | 'UGX' /** United States Dollars (USD). */ | 'USD' /** United States Dollars Coin (USDC). */ | 'USDC' /** Uruguayan Pesos (UYU). */ | 'UYU' /** Uzbekistan som (UZS). */ | 'UZS' /** Venezuelan Bolivares (VED). */ | 'VED' /** Venezuelan Bolivares (VEF). */ | 'VEF' /** Venezuelan Bolivares Soberanos (VES). */ | 'VES' /** Vietnamese đồng (VND). */ | 'VND' /** Vanuatu Vatu (VUV). */ | 'VUV' /** Samoan Tala (WST). */ | 'WST' /** Central African CFA Franc (XAF). */ | 'XAF' /** East Caribbean Dollar (XCD). */ | 'XCD' /** West African CFA franc (XOF). */ | 'XOF' /** CFP Franc (XPF). */ | 'XPF' /** Unrecognized currency. */ | 'XXX' /** Yemeni Rial (YER). */ | 'YER' /** South African Rand (ZAR). */ | 'ZAR' /** Zambian Kwacha (ZMW). */ | 'ZMW'; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type Customer = HasMetafields & HasStoreCreditAccounts & Node & { __typename?: 'Customer'; /** The addresses associated with the customer. */ addresses: CustomerAddressConnection; /** The list of all available payment methods that can be used for recurring and future payments. */ availablePaymentMethods: Array; /** The list of wallet payment configs for providers that the payment method accepts. */ availableWalletPaymentConfigs: Array; /** The list of contacts the customer is associated with. */ companyContacts: CompanyContactConnection; /** The date and time when the customer was created. */ createdAt: Scalars['DateTime']['output']; /** The date and time when the customer was created. */ creationDate: Scalars['DateTime']['output']; /** A Credit Card resource identified by ID. */ creditCard?: Maybe; /** The stored Credit Cards associated with the customer. */ creditCards: CustomerCreditCardConnection; /** The default address of the customer. */ defaultAddress?: Maybe; /** The full name of the customer, based on the first_name and last_name values. If these aren't available, it falls back to the customer's email address, and if that isn't available, the customer's phone number. */ displayName: Scalars['String']['output']; /** The Draft Orders associated with the customer. */ draftOrders: DraftOrderConnection; /** The email address of the customer. */ emailAddress?: Maybe; /** The first name of the customer. */ firstName?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The URL to the avatar image of the customer. */ imageUrl: Scalars['URL']['output']; /** The customer's most recently updated, incomplete checkout. */ lastIncompleteCheckout?: Maybe; /** The last name of the customer. */ lastName?: Maybe; /** A metafield found by namespace and key. */ metafield?: Maybe; /** * The metafields associated with the resource matching the * supplied list of namespaces and keys. */ metafields: Array>; /** The orders associated with the customer. */ orders: OrderConnection; /** The payment instrument corresponding to the provided ID. */ paymentInstrument?: Maybe< BankPaymentInstrument | CustomerCreditCard | PaypalBillingAgreement >; /** The list of stored payment instruments. */ paymentInstruments: PaymentInstrumentConnection; /** A PayPal Billing Agreement resource. */ paypalBillingAgreement?: Maybe; /** The phone number of the customer. */ phoneNumber?: Maybe; /** A Return identified by ID. */ return?: Maybe; /** A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout. */ storeCreditAccounts: StoreCreditAccountConnection; /** Returns a `SubscriptionContract` resource by ID. */ subscriptionContract?: Maybe; /** The Subscription Contracts associated with the customer. */ subscriptionContracts: SubscriptionContractConnection; /** A comma-separated list of tags that have been added to the customer. */ tags: Array; /** The list of tax exemptions applied to the customer with additional details. */ taxExemptionsDetails: Array; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerAddressesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; skipDefault?: InputMaybe; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerCompanyContactsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerCreditCardArgs = { id: Scalars['ID']['input']; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerCreditCardsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerMetafieldArgs = { key: Scalars['String']['input']; namespace: Scalars['String']['input']; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerMetafieldsArgs = { identifiers: Array; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerPaymentInstrumentArgs = { id: Scalars['ID']['input']; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerPaymentInstrumentsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerReturnArgs = { id: Scalars['ID']['input']; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerStoreCreditAccountsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerSubscriptionContractArgs = { id: Scalars['ID']['input']; }; /** Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerSubscriptionContractsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** * Represents a customer's mailing address. * For example, a customer's default address and an order's billing address are both mailing addresses. * Apps using the Customer Account API must meet the * protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerAddress = Node & { __typename?: 'CustomerAddress'; /** The first line of the address. Typically the street address or PO Box number. */ address1?: Maybe; /** The second line of the address. This is typically the apartment, suite, or unit number. */ 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 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; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The last name of the customer. */ lastName?: Maybe; /** The full name of the customer, based on firstName and lastName. */ name?: Maybe; /** * The customer's unique phone number. * * Formatted using E.164 standard. For example, _+16135551111_. */ phoneNumber?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. */ territoryCode?: Maybe; /** The zip or postal code of the address. */ zip?: Maybe; /** * The alphanumeric code for the region. * * For example, ON. */ zoneCode?: Maybe; }; /** * Represents a customer's mailing address. * For example, a customer's default address and an order's billing address are both mailing addresses. * Apps using the Customer Account API must meet the * protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerAddressFormattedArgs = { withCompany?: InputMaybe; withName?: InputMaybe; }; /** An auto-generated type for paginating through multiple CustomerAddresses. */ export type CustomerAddressConnection = { __typename?: 'CustomerAddressConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in CustomerAddressEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** Return type for `customerAddressCreate` mutation. */ export type CustomerAddressCreatePayload = { __typename?: 'CustomerAddressCreatePayload'; /** The created customer address. */ customerAddress?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `customerAddressDelete` mutation. */ export type CustomerAddressDeletePayload = { __typename?: 'CustomerAddressDeletePayload'; /** The ID of the deleted address. */ deletedAddressId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** An auto-generated type which holds one CustomerAddress and a cursor during pagination. */ export type CustomerAddressEdge = { __typename?: 'CustomerAddressEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of CustomerAddressEdge. */ node: CustomerAddress; }; /** The input fields to create or update a mailing address. */ export type CustomerAddressInput = { /** The first line of the address. Typically the street address or PO Box number. */ address1?: InputMaybe; /** The second line of the address. Typically the apartment, suite, or unit number. */ address2?: InputMaybe; /** The name of the city, district, village, or town. */ city?: InputMaybe; /** The name of the customer's company or organization. */ company?: InputMaybe; /** The first name of the customer. */ firstName?: InputMaybe; /** The last name of the customer. */ lastName?: InputMaybe; /** The customer's unique phone number, formatted using E.164 standard. For example, _+16135551111_. */ phoneNumber?: InputMaybe; /** * The country code, in ISO 3166-1 format. Accepts either a two-letter [alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), * a three-letter [alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3), or a three-digit [numeric code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric). * For example, `US`, `USA`, or `840` represents the United States. */ territoryCode?: InputMaybe; /** The zip or postal code of the address. */ zip?: InputMaybe; /** * The alphanumeric code for the region of the address, such as the province, state, or district. * For example, 'ON' for Ontario, Canada. */ zoneCode?: InputMaybe; }; /** Return type for `customerAddressUpdate` mutation. */ export type CustomerAddressUpdatePayload = { __typename?: 'CustomerAddressUpdatePayload'; /** The updated address. */ customerAddress?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The credit card payment instrument. */ export type CustomerCreditCard = Node & PaymentInstrument & { __typename?: 'CustomerCreditCard'; /** The billing address associated with the credit card. */ billingAddress?: Maybe; /** The brand of the credit card. */ brand: Scalars['String']['output']; /** Whether the credit card is the default payment method. */ default: Scalars['Boolean']['output']; /** The list of open draft orders associated with this payment instrument. */ draftOrders: DraftOrderConnection; /** Whether the credit card is about to expire. */ expiresSoon: Scalars['Boolean']['output']; /** The expiry month of the credit card. */ expiryMonth: Scalars['Int']['output']; /** The expiry year of the credit card. */ expiryYear: Scalars['Int']['output']; /** The BIN number of the credit card. */ firstDigits?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The last 4 digits of the credit card. */ lastDigits: Scalars['String']['output']; /** The masked credit card number, displaying only the last 4 digits. */ maskedNumber: Scalars['String']['output']; /** The name of the card holder. */ name: Scalars['String']['output']; /** The list of open draft orders of an associated credit card. */ openDraftOrders: DraftOrderConnection; /** The list of pending orders associated with this payment instrument. */ orders: OrderConnection; /** The list of pending orders associated with this credit card. */ pendingOrders: OrderConnection; /** Whether this credit card has permission to be shown at checkout for future purchases. */ permissionToShowAtCheckout: Scalars['Boolean']['output']; /** The list of subscription contracts charged against this credit card. */ subscriptionContracts: SubscriptionContractConnection; /** The last 4 digits of the Device Account Number. */ virtualLastDigits?: Maybe; /** The type of wallet, if the credit card is associated with a wallet. */ walletType?: Maybe; }; /** The credit card payment instrument. */ export type CustomerCreditCardDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The credit card payment instrument. */ export type CustomerCreditCardOpenDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The credit card payment instrument. */ export type CustomerCreditCardOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The credit card payment instrument. */ export type CustomerCreditCardPendingOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The credit card payment instrument. */ export type CustomerCreditCardSubscriptionContractsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** An auto-generated type for paginating through multiple CustomerCreditCards. */ export type CustomerCreditCardConnection = { __typename?: 'CustomerCreditCardConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in CustomerCreditCardEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one CustomerCreditCard and a cursor during pagination. */ export type CustomerCreditCardEdge = { __typename?: 'CustomerCreditCardEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of CustomerCreditCardEdge. */ node: CustomerCreditCard; }; /** An email address associated with a customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerEmailAddress = { __typename?: 'CustomerEmailAddress'; /** The email address of the customer. */ emailAddress?: Maybe; /** The customer's subscription status for email marketing. */ marketingState: EmailMarketingState; }; /** Return type for `customerEmailMarketingOptIn` mutation. */ export type CustomerEmailMarketingOptInPayload = { __typename?: 'CustomerEmailMarketingOptInPayload'; /** The customer who was force subscribed to email marketing. */ customerEmailAddress?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `customerEmailMarketingSubscribe` mutation. */ export type CustomerEmailMarketingSubscribePayload = { __typename?: 'CustomerEmailMarketingSubscribePayload'; /** The customer's email address that's subscribed to the email marketing. */ emailAddress?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `customerEmailMarketingUnsubscribe` mutation. */ export type CustomerEmailMarketingUnsubscribePayload = { __typename?: 'CustomerEmailMarketingUnsubscribePayload'; /** The customer's email address that's unsubscribed from the email marketing. */ emailAddress?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** * Represents a customer's mailing address. * For example, a customer's default address and an order's billing address are both mailing addresses. */ export type CustomerMailingAddress = Node & { __typename?: 'CustomerMailingAddress'; /** The first line of the address. Typically the street address or PO Box number. */ address1?: Maybe; /** The second line of the address. This is typically the apartment, suite, or unit number. */ 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 two-letter code for the country of the address. * * For example, US. */ countryCodeV2?: Maybe; /** Indicates whether the address is the default address or not. */ defaultAddress: Scalars['Boolean']['output']; /** 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; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The last name of the customer. */ lastName?: Maybe; /** The latitude coordinate of the customer's address. */ latitude?: Maybe; /** The longitude coordinate of the customer's address. */ longitude?: Maybe; /** The full name of the customer, based on firstName and lastName. */ name?: Maybe; /** * The customer's unique phone number. * * Formatted using E.164 standard. For example, _+16135551111_. */ phone?: Maybe; /** * The customer's unique phone number. * * Formatted using E.164 standard. For example, _+16135551111_. */ phoneNumber?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** * The alphanumeric code for the region. * * For example, ON. */ provinceCode?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. */ territoryCode?: Maybe; /** Indicates whether the address was geolocated and is a valid address. The field returns `false` if the verification failed, or if the job to verify this address was never started. */ verified: Scalars['Boolean']['output']; /** The zip or postal code of the address. */ zip?: Maybe; /** * The alphanumeric code for the region. * * For example, ON. */ zoneCode?: Maybe; }; /** * Represents a customer's mailing address. * For example, a customer's default address and an order's billing address are both mailing addresses. */ export type CustomerMailingAddressFormattedArgs = { withCompany?: InputMaybe; withName?: InputMaybe; }; /** The input fields to create or update a mailing address. */ export type CustomerMailingAddressInput = { /** The first line of the address. Typically the street address or PO Box number. */ address1?: InputMaybe; /** The second line of the address. Typically the apartment, suite, or unit number. */ address2?: InputMaybe; /** The name of the city, district, village, or town. */ city?: InputMaybe; /** The name of the customer's company or organization. */ company?: InputMaybe; /** The two-letter code for the country of the address. */ countryCode?: InputMaybe; /** The first name of the customer. */ firstName?: InputMaybe; /** The last name of the customer. */ lastName?: InputMaybe; /** The customer's unique phone number, formatted using E.164 standard. For example, _+16135551111_. */ phone?: InputMaybe; /** The customer's unique phone number, formatted using E.164 standard. For example, _+16135551111_. */ phoneNumber?: InputMaybe; /** The zip or postal code of the address. */ zip?: InputMaybe; /** * The code for the region of the address, such as the province, * state, or district. For example, QC for Quebec, Canada. */ zoneCode?: InputMaybe; }; /** Defines the phone number of the customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type CustomerPhoneNumber = { __typename?: 'CustomerPhoneNumber'; /** Indicates whether the customer has subscribed to SMS marketing material. */ marketingState: SmsMarketingState; /** The customer's phone number. */ phoneNumber: Scalars['String']['output']; }; /** The input fields to update a customer's personal information. */ export type CustomerUpdateInput = { /** The customer's first name. */ firstName?: InputMaybe; /** The customer's last name. */ lastName?: InputMaybe; }; /** Return type for `customerUpdate` mutation. */ export type CustomerUpdatePayload = { __typename?: 'CustomerUpdatePayload'; /** The customer's personal information that has been updated. */ customer?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The different types of delivery option groups. */ export type DeliveryOptionGroupType = /** A one-time purchase. */ | 'ONE_TIME_PURCHASE' /** A subscription. */ | 'SUBSCRIPTION'; /** Configuration of the deposit. */ export type DepositConfiguration = DepositPercentage; /** A percentage deposit. */ export type DepositPercentage = { __typename?: 'DepositPercentage'; /** The percentage value of the deposit. */ percentage: Scalars['Float']['output']; }; /** Represents an amount discounting the line that has been allocated by a discount. */ export type DiscountAllocation = { __typename?: 'DiscountAllocation'; /** The amount of discount allocated. */ allocatedAmount: MoneyV2; /** The discount from which this allocated amount originated. */ discountApplication: | AutomaticDiscountApplication | DiscountCodeApplication | ManualDiscountApplication | ScriptDiscountApplication; }; /** Captures the intentions of a discount source at the time of application. */ export type DiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** The method by which the discount's value is allocated onto its entitled lines. */ export type DiscountApplicationAllocationMethod = /** The value is spread across all entitled lines. */ | 'ACROSS' /** The value is applied onto every entitled line. */ | 'EACH' /** The value is specifically applied onto a particular line. */ | 'ONE'; /** An auto-generated type for paginating through multiple DiscountApplications. */ export type DiscountApplicationConnection = { __typename?: 'DiscountApplicationConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in DiscountApplicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array< | AutomaticDiscountApplication | DiscountCodeApplication | ManualDiscountApplication | ScriptDiscountApplication >; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one DiscountApplication and a cursor during pagination. */ export type DiscountApplicationEdge = { __typename?: 'DiscountApplicationEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of DiscountApplicationEdge. */ node: | AutomaticDiscountApplication | DiscountCodeApplication | ManualDiscountApplication | ScriptDiscountApplication; }; /** * The lines on the order to which the discount is applied, of the type defined by * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount. * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines. */ export type DiscountApplicationTargetSelection = /** The discount is allocated onto all the lines. */ | 'ALL' /** The discount is allocated onto only the lines that it's entitled for. */ | 'ENTITLED' /** The discount is allocated onto explicitly chosen lines. */ | 'EXPLICIT'; /** The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. */ export type DiscountApplicationTargetType = /** The discount applies onto line items. */ | 'LINE_ITEM' /** The discount applies onto shipping lines. */ | 'SHIPPING_LINE'; /** The type of the discount application. */ export type DiscountApplicationType = /** Automatic discount application type. */ | 'AUTOMATIC' /** Discount code discount application type. */ | 'DISCOUNT_CODE' /** Manual discount application type. */ | 'MANUAL' /** Script discount application type. */ | 'SCRIPT'; /** Captures the intentions of a discount code at the time that it is applied. */ 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 used at the time of application. */ code: Scalars['String']['output']; /** The lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The value of the discount application. */ value: PricingValue; }; /** The type of line (line item or shipping line) on an order that the subscription discount is applicable towards. */ export type DiscountTargetType = /** The discount applies onto line items. */ | 'LINE_ITEM' /** The discount applies onto shipping lines. */ | 'SHIPPING_LINE'; /** The type of the subscription discount. */ export type DiscountType = /** Automatic discount type. */ | 'AUTOMATIC_DISCOUNT' /** Code discount type. */ | 'CODE_DISCOUNT' /** Manual discount type. */ | 'MANUAL'; /** Represents an error in the input of a mutation. */ export type DisplayableError = { /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** A unique string representing the address of a Shopify store on the Internet. */ export type Domain = Node & { __typename?: 'Domain'; /** The host name of the domain (for example, `example.com`). */ host: Scalars['String']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The host of the primary domain that this domain redirects to (for example, `example.com`). */ redirectHost?: Maybe; /** The URL of the domain (for example, `example.com`). */ url: Scalars['URL']['output']; }; /** A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type DraftOrder = Node & { __typename?: 'DraftOrder'; /** The billing address of the customer. */ billingAddress?: Maybe; /** Whether the customer who made the draft order has an associated enabled contact. */ contactExists: Scalars['Boolean']['output']; /** The date and time when the draft order was created in Shopify. */ createdAt: Scalars['DateTime']['output']; /** The three-letter code for the currency of the store at the time that the invoice is sent. */ currencyCode: CurrencyCode; /** The customer who placed the order. */ customer?: Maybe; /** The discount information for the draft order. */ discountInformation: DraftOrderDiscountInformation; /** The email address of the customer, which is used to send notifications to. */ email?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** Whether the draft order is created from the online store and is open. */ inReview: Scalars['Boolean']['output']; /** The link to the checkout, which is sent to the customer in the invoice email. */ invoiceUrl?: Maybe; /** The merchandise lines marked as fees with total value, aggregated by title. */ legacyAggregatedMerchandiseTermsAsFees: Array; /** Whether or not products marked as fees should be rendered as money lines. */ legacyRepresentProductsAsFees: Scalars['Boolean']['output']; /** The subtotal of the line items (doesn't include shipping charges, shipping discounts, taxes, or fees). */ legacySubtotalWithoutFees: MoneyV2; /** The list of the line items in the draft order. */ lineItems: DraftOrderLineItemConnection; /** The summary of draft order line items quantity. */ lineItemsSummary?: Maybe; /** The unique identifier for the draft order, which is unique within the store. For example, _#D1223_. */ name: Scalars['String']['output']; /** The order that was created from this draft order. */ order?: Maybe; /** The phone number assigned to the draft order. */ phone?: Maybe; /** The purchasing entity for the draft order. */ purchasingEntity?: Maybe; /** Whether the draft order requires shipping or not. */ requiresShipping: Scalars['Boolean']['output']; /** The shipping address of the customer. */ shippingAddress?: Maybe; /** The status of the draft order. */ status: DraftOrderStatus; /** The subtotal of the line items (doesn't include shipping charges, shipping discounts, or taxes). */ subtotalPrice: MoneyV2; /** The subtotal of the line items (doesn't include shipping charges, taxes, or any discounts). */ subtotalPriceBeforeDiscounts: MoneyV2; /** Indicates whether the draft order is tax exempt. */ taxExempt: Scalars['Boolean']['output']; /** Whether the line item prices include taxes. */ taxesIncluded: Scalars['Boolean']['output']; /** The total price of line items for this draft order. */ totalLineItemsPrice: MoneyV2; /** The total amount of the draft order (includes taxes, shipping charges, and discounts). */ totalPrice: MoneyV2; /** The total shipping charge for the draft order. */ totalShippingPrice: MoneyV2; /** The total amount of taxes for the draft order. */ totalTax: MoneyV2; /** The total weight (in grams) of the draft order. */ totalWeight: Scalars['UnsignedInt64']['output']; /** * The 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']['output']; }; /** A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type DraftOrderLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The order-level discount applied to a draft order. */ export type DraftOrderAppliedDiscount = { __typename?: 'DraftOrderAppliedDiscount'; /** The amount of money discounted. */ discountValue: MoneyV2; /** The name of the order-level discount. */ title?: Maybe; }; /** The set of valid sort keys for the DraftOrderByCompany query. */ export type DraftOrderByCompanySortKeys = /** Sort by the `customer_name` value. */ | 'CUSTOMER_NAME' /** Sort by the `id` value. */ | 'ID' /** Sort by the `number` value. */ | 'NUMBER' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. */ | 'RELEVANCE' /** Sort by the `status` value. */ | 'STATUS' /** Sort by the `total_price` value. */ | 'TOTAL_PRICE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** The set of valid sort keys for the DraftOrderByLocation query. */ export type DraftOrderByLocationSortKeys = /** Sort by the `customer_name` value. */ | 'CUSTOMER_NAME' /** Sort by the `id` value. */ | 'ID' /** Sort by the `number` value. */ | 'NUMBER' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. */ | 'RELEVANCE' /** Sort by the `status` value. */ | 'STATUS' /** Sort by the `total_price` value. */ | 'TOTAL_PRICE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** An auto-generated type for paginating through multiple DraftOrders. */ export type DraftOrderConnection = { __typename?: 'DraftOrderConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in DraftOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** The discount information associated with a draft order. */ export type DraftOrderDiscountInformation = { __typename?: 'DraftOrderDiscountInformation'; /** The order-level discount applied to the draft order. */ appliedDiscount?: Maybe; /** The total discounts applied to the draft order. */ totalDiscounts: MoneyV2; }; /** An auto-generated type which holds one DraftOrder and a cursor during pagination. */ export type DraftOrderEdge = { __typename?: 'DraftOrderEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of DraftOrderEdge. */ node: DraftOrder; }; /** A line item included in a draft order. */ export type DraftOrderLineItem = Node & { __typename?: 'DraftOrderLineItem'; /** The discount information for the draft order line item. */ discountInformation: DraftOrderLineItemDiscountInformation; /** The total price of the line item after discounts have been applied. */ discountedTotal: MoneyV2; /** The discounted total divided by the quantity, resulting in the value of the discount per unit. */ discountedUnitPrice: MoneyV2; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The image associated with the line item. */ image?: Maybe; /** Whether this is line item is marked as a fee. */ legacyFee: Scalars['Boolean']['output']; /** The fee's description, if this line item has been marked as a fee. */ legacyFeeDescription?: Maybe; /** The fee's title, if this line item has been marked as a fee. */ legacyFeeTitle?: Maybe; /** The name of the product. */ name: Scalars['String']['output']; /** The total price of the line item, based on the original unit price of the variant multiplied by the quantity. This total doesn't include any discounts. */ originalTotal: MoneyV2; /** The price of the variant without any discounts applied. */ originalUnitPrice: MoneyV2; /** The quantity of this variant item in the draft order. */ quantity: Scalars['Int']['output']; /** Whether the variant requires physical shipping. */ requiresShipping: Scalars['Boolean']['output']; /** The SKU number of the variant. */ sku?: Maybe; /** Whether the variant is taxable. */ taxable: Scalars['Boolean']['output']; /** The title of the product or variant. This only applies to custom line items. */ title: Scalars['String']['output']; /** The name of the product variant. */ variantTitle?: Maybe; /** The name of the vendor of the variant. */ vendor?: Maybe; /** The weight of the line item, including the unit and value. */ weight?: Maybe; }; /** An auto-generated type for paginating through multiple DraftOrderLineItems. */ export type DraftOrderLineItemConnection = { __typename?: 'DraftOrderLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in DraftOrderLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** The discount information for the draft order line item. */ export type DraftOrderLineItemDiscountInformation = { __typename?: 'DraftOrderLineItemDiscountInformation'; /** The discount's name that displays to merchants in the Shopify admin and to customers. */ title?: Maybe; /** The total discount applied to the line item. */ totalDiscount: MoneyV2; }; /** An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination. */ export type DraftOrderLineItemEdge = { __typename?: 'DraftOrderLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of DraftOrderLineItemEdge. */ node: DraftOrderLineItem; }; /** The quantitative summary of the line items in a specific draft order. */ export type DraftOrderLineItemsSummary = { __typename?: 'DraftOrderLineItemsSummary'; /** The total number of line items in the draft order. */ lineItemCount: Scalars['Int']['output']; /** The total quantity of all legacy fee line items in the draft order. */ totalQuantityOfLegacyFeeLineItems: Scalars['Int']['output']; /** The total quantity of all line items in the draft order. */ totalQuantityOfLineItems: Scalars['Int']['output']; }; /** The set of valid sort keys for the DraftOrder query. */ export type DraftOrderSortKeys = /** Sort by the `customer_name` value. */ | 'CUSTOMER_NAME' /** Sort by the `id` value. */ | 'ID' /** Sort by the `number` value. */ | 'NUMBER' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. */ | 'RELEVANCE' /** Sort by the `status` value. */ | 'STATUS' /** Sort by the `total_price` value. */ | 'TOTAL_PRICE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** The valid statuses for a draft order. */ export type DraftOrderStatus = /** The draft order has been paid. */ | 'COMPLETED' /** An invoice for the draft order has been sent to the customer. */ | 'INVOICE_SENT' /** The draft order is open. It has not been paid, and an invoice hasn't been sent. */ | 'OPEN'; /** A sale that includes a duty charge. */ export type DutySale = Node & Sale & { __typename?: 'DutySale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** Represents the possible email marketing states for a customer. */ export type EmailMarketingState = /** The customer’s email marketing state is invalid. */ | 'INVALID' /** The customer isn't subscribed to email marketing. */ | 'NOT_SUBSCRIBED' /** The customer is in the process of subscribing to email marketing. */ | 'PENDING' /** The customer's personal data has been erased. This value is internally-set and read-only. */ | 'REDACTED' /** The customer is subscribed to email marketing. */ | 'SUBSCRIBED' /** The customer is not currently subscribed to email marketing but was previously subscribed. */ | 'UNSUBSCRIBED'; /** An item for exchange. */ export type ExchangeLineItem = Node & { __typename?: 'ExchangeLineItem'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The image associated to the line item's variant. */ image?: Maybe; /** Whether the product has only a single variant with the default option and value. */ productHasOnlyDefaultVariant?: Maybe; /** The ID of the product at time of refund creation. */ productId?: Maybe; /** The number of variant items ordered. */ quantity: Scalars['Int']['output']; /** The title of the product at time of order creation. */ title?: Maybe; /** The ID of the variant at time of refund creation. */ variantId?: Maybe; /** The variant SKU number. */ variantSku?: Maybe; /** The title of the variant at time of refund creation. */ variantTitle?: Maybe; }; /** An auto-generated type for paginating through multiple ExchangeLineItems. */ export type ExchangeLineItemConnection = { __typename?: 'ExchangeLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in ExchangeLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ExchangeLineItem and a cursor during pagination. */ export type ExchangeLineItemEdge = { __typename?: 'ExchangeLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of ExchangeLineItemEdge. */ node: ExchangeLineItem; }; /** Tokens used by ui extensions to query various APIs. */ export type ExtensionApiTokens = { __typename?: 'ExtensionApiTokens'; /** The token for querying the storefront API. */ storefrontApi?: Maybe; }; /** Ephemeral token used by ui extensions to query the storefront API. */ export type ExtensionStorefrontApiToken = { __typename?: 'ExtensionStorefrontApiToken'; /** The expiration time of the token. */ expiresAt: Scalars['ISO8601DateTime']['output']; /** The ephemeral token used for querying the storefront API. */ token: Scalars['String']['output']; }; /** A sale associated with a fee. */ export type FeeSale = Node & Sale & { __typename?: 'FeeSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** Represents a single fulfillment in an order. */ export type Fulfillment = Node & { __typename?: 'Fulfillment'; /** The date and time when the fulfillment was created. */ createdAt: Scalars['DateTime']['output']; /** The estimated delivery time of this fulfillment. */ estimatedDeliveryAt?: Maybe; /** A collection of fulfillment events. */ events: FulfillmentEventConnection; /** The line items in the fulfillment. */ fulfillmentLineItems: FulfillmentLineItemConnection; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** Whether the fulfillment is picked up locally. */ isPickedUp: Scalars['Boolean']['output']; /** The latest shipment status for the fulfillment. */ latestShipmentStatus?: Maybe; /** The pickup address for the fulfillment. */ pickupAddress?: Maybe; /** Whether any line items in the fulfillment require shipping. */ requiresShipping: Scalars['Boolean']['output']; /** The status of the fulfillment. */ status?: Maybe; /** The tracking information associated with the fulfillment. */ trackingInformation: Array; /** The date and time when the fulfillment was updated. */ updatedAt: Scalars['DateTime']['output']; }; /** Represents a single fulfillment in an order. */ export type FulfillmentEventsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Represents a single fulfillment in an order. */ export type FulfillmentFulfillmentLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** An auto-generated type for paginating through multiple Fulfillments. */ export type FulfillmentConnection = { __typename?: 'FulfillmentConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in FulfillmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one Fulfillment and a cursor during pagination. */ export type FulfillmentEdge = { __typename?: 'FulfillmentEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of FulfillmentEdge. */ node: Fulfillment; }; /** An event that occurred for a fulfillment. */ export type FulfillmentEvent = Node & { __typename?: 'FulfillmentEvent'; /** The time when this fulfillment event occurred. */ happenedAt: Scalars['DateTime']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The status of the fulfillment event. */ status: FulfillmentEventStatus; }; /** An auto-generated type for paginating through multiple FulfillmentEvents. */ export type FulfillmentEventConnection = { __typename?: 'FulfillmentEventConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in FulfillmentEventEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one FulfillmentEvent and a cursor during pagination. */ export type FulfillmentEventEdge = { __typename?: 'FulfillmentEventEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of FulfillmentEventEdge. */ node: FulfillmentEvent; }; /** The set of valid sort keys for the FulfillmentEvent query. */ export type FulfillmentEventSortKeys = /** Sort by the `happened_at` value. */ | 'HAPPENED_AT' /** Sort by the `id` value. */ | 'ID'; /** The status of a fulfillment event. */ export type FulfillmentEventStatus = /** A delivery was attempted. */ | 'ATTEMPTED_DELIVERY' /** The fulfillment has been picked up by the carrier. */ | 'CARRIER_PICKED_UP' /** The fulfillment is confirmed. */ | 'CONFIRMED' /** The fulfillment is delayed. */ | 'DELAYED' /** The fulfillment was successfully delivered. */ | 'DELIVERED' /** The fulfillment request failed. */ | 'FAILURE' /** The fulfillment is in transit. */ | 'IN_TRANSIT' /** A purchased shipping label has been printed. */ | 'LABEL_PRINTED' /** A shipping label has been purchased. */ | 'LABEL_PURCHASED' /** The fulfillment is out for delivery. */ | 'OUT_FOR_DELIVERY' /** The fulfillment was successfully picked up. */ | 'PICKED_UP' /** The fulfillment is ready to be picked up. */ | 'READY_FOR_PICKUP'; /** Represents a line item from an order that's included in a fulfillment. */ export type FulfillmentLineItem = Node & { __typename?: 'FulfillmentLineItem'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The line item associated with the order. */ lineItem: LineItem; /** The number of line items in the fulfillment. */ quantity?: Maybe; }; /** An auto-generated type for paginating through multiple FulfillmentLineItems. */ export type FulfillmentLineItemConnection = { __typename?: 'FulfillmentLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in FulfillmentLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. */ export type FulfillmentLineItemEdge = { __typename?: 'FulfillmentLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of FulfillmentLineItemEdge. */ node: FulfillmentLineItem; }; /** The set of valid sort keys for the Fulfillment query. */ export type FulfillmentSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID'; /** The status of a fulfillment. */ export type FulfillmentStatus = /** The fulfillment was canceled. */ | 'CANCELLED' /** There was an error with the fulfillment request. */ | 'ERROR' /** The fulfillment request failed. */ | 'FAILURE' /** The third-party fulfillment service has acknowledged the fulfillment and is processing it. */ | 'OPEN' /** Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`. */ | 'PENDING' /** The fulfillment was completed successfully. */ | 'SUCCESS'; /** The generic file resource lets you manage files in a merchant's store. Generic files include any file that doesn't fit into a designated type such as image or video. Example: PDF, JSON. */ export type GenericFile = Media & { __typename?: 'GenericFile'; /** A word or phrase to indicate the contents of a file. */ alt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The MIME type of the file. */ mimeType?: Maybe; /** The size of the original file in bytes. */ originalFileSize?: Maybe; /** The preview image for the media. */ previewImage?: Maybe; /** The URL of the file. */ url?: Maybe; }; /** The gift card payment details related to a transaction. */ export type GiftCardDetails = { __typename?: 'GiftCardDetails'; /** The balance of the gift card in shop and presentment currencies. */ balance: MoneyV2; /** The last characters of the gift card. */ last4: Scalars['String']['output']; }; /** A sale associated with a gift card. */ export type GiftCardSale = Node & Sale & { __typename?: 'GiftCardSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The line item associated with the sale. */ lineItem: LineItem; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** The input fields for the billing address received from Google Pay. */ export type GooglePayBillingAddressInput = { /** The first line of the address, typically the street address or PO Box number. */ address1?: InputMaybe; /** The second line of the address, typically the apartment, suite, or unit number. */ address2?: InputMaybe; /** The region of the address, such as the province, state, or district. */ administrativeArea?: InputMaybe; /** The two-letter code for the country of the address. */ countryCode?: InputMaybe; /** The name of the city, district, village, or town. */ locality?: InputMaybe; /** The name of the customer. */ name?: InputMaybe; /** The telephone number of the customer. */ phoneNumber?: InputMaybe; /** The zip or postal code of the address. */ postalCode?: InputMaybe; }; /** Return type for `googlePayCreditCardAdd` mutation. */ export type GooglePayCreditCardAddPayload = { __typename?: 'GooglePayCreditCardAddPayload'; /** The updated credit card. */ creditCard?: Maybe; /** If the card verification result is processing. When this is true, credit_card will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `googlePayCreditCardUpdate` mutation. */ export type GooglePayCreditCardUpdatePayload = { __typename?: 'GooglePayCreditCardUpdatePayload'; /** The updated credit card. */ creditCard?: Maybe; /** If the card verification result is processing. When this is true, credit_card will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The configuration settings for the Google Pay wallet. */ export type GooglePayWalletConfig = { __typename?: 'GooglePayWalletConfig'; /** The authentication methods allowed by Google Pay. */ allowedAuthMethods: Array; /** The card networks accepted by Google Pay. */ allowedCardNetworks: Array; /** The Auth JWT used for Google Pay requests. */ authJwt: Scalars['String']['output']; /** The current operating environment (TEST or PRODUCTION). */ environment: Scalars['String']['output']; /** The gateway name for Google Pay. */ gateway: Scalars['String']['output']; /** The gateway merchant ID for Google Pay. */ gatewayMerchantId: Scalars['String']['output']; /** The merchant ID for Google Pay. */ merchantId: Scalars['String']['output']; /** The merchant name for Google Pay. */ merchantName: Scalars['String']['output']; /** The merchant origin for Google Pay. */ merchantOrigin: Scalars['String']['output']; }; /** * Represents a summary of the current version of data in a resource. * * The `compare_digest` field can be used as input for mutations that implement a compare-and-swap mechanism. */ export type HasCompareDigest = { /** The data stored in the resource, represented as a digest. */ compareDigest: Scalars['String']['output']; }; /** The information about the metafields associated with the specified resource. */ export type HasMetafields = { /** A metafield found by namespace and key. */ metafield?: Maybe; /** * The metafields associated with the resource matching the * supplied list of namespaces and keys. */ metafields: Array>; }; /** The information about the metafields associated with the specified resource. */ export type HasMetafieldsMetafieldArgs = { key: Scalars['String']['input']; namespace: Scalars['String']['input']; }; /** The information about the metafields associated with the specified resource. */ export type HasMetafieldsMetafieldsArgs = { identifiers: Array; }; /** The input fields to identify a metafield on an owner resource by namespace and key. */ export type HasMetafieldsIdentifier = { /** The identifier for the metafield. */ key: Scalars['String']['input']; /** A container for a set of metafields. */ namespace: Scalars['String']['input']; }; /** Represents information about the store credit accounts associated to the specified owner. */ export type HasStoreCreditAccounts = { /** A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout. */ storeCreditAccounts: StoreCreditAccountConnection; }; /** Represents information about the store credit accounts associated to the specified owner. */ export type HasStoreCreditAccountsStoreCreditAccountsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; }; /** Represents an image resource. */ export type Image = { __typename?: 'Image'; /** A word or phrase to share the nature or contents of an image. */ altText?: Maybe; /** The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ height?: Maybe; /** A unique ID for the image. */ id?: Maybe; /** * The location of the original image as a URL. * * If there are any existing transformations in the original source URL, they will remain and not be stripped. * @deprecated Use `url` instead. */ originalSrc: Scalars['URL']['output']; /** * The location of the image as a URL. * @deprecated Use `url` instead. */ src: Scalars['URL']['output']; /** * The ThumbHash of the image. * * Useful to display placeholder images while the original image is loading. */ thumbhash?: Maybe; /** * 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 doesn't support will be ignored. * @deprecated Use `url(transform:)` instead */ transformedSrc: Scalars['URL']['output']; /** * The location of the image as a URL. * * If no transform options are specified, then the original image will be preserved including any pre-applied transforms. * * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. * * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). */ url: Scalars['URL']['output']; /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ width?: Maybe; }; /** Represents an image resource. */ export type ImageTransformedSrcArgs = { crop?: InputMaybe; maxHeight?: InputMaybe; maxWidth?: InputMaybe; preferredContentType?: InputMaybe; scale?: InputMaybe; }; /** Represents an image resource. */ export type ImageUrlArgs = { transform?: InputMaybe; }; /** List of supported image content types. */ export type ImageContentType = /** A BMP image. */ | 'BMP' /** A JPG image. */ | 'JPG' /** A PNG image. */ | 'PNG' /** A WEBP image. */ | 'WEBP'; /** * The available options for transforming an image. * * All transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored. */ export type ImageTransformInput = { /** * The region of the image to remain after cropping. * Must be used in conjunction with the `maxWidth` and/or `maxHeight` fields, where the `maxWidth` and `maxHeight` aren't equal. * The `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ maxWidth: 5, maxHeight: 10, crop: LEFT }` will result * in an image with a width of 5 and height of 10, where the right side of the image is removed. */ crop?: InputMaybe; /** Image height in pixels between 1 and 5760. */ maxHeight?: InputMaybe; /** Image width in pixels between 1 and 5760. */ maxWidth?: InputMaybe; /** * Convert the source image into the preferred content type. * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`. */ preferredContentType?: InputMaybe; /** Image size multiplier for high-resolution retina displays. Must be within 1..3. */ scale?: InputMaybe; }; /** Language codes supported by Shopify. */ export type LanguageCode = /** Afrikaans. */ | 'AF' /** Akan. */ | 'AK' /** Amharic. */ | 'AM' /** Arabic. */ | 'AR' /** Assamese. */ | 'AS' /** Azerbaijani. */ | 'AZ' /** Belarusian. */ | 'BE' /** Bulgarian. */ | 'BG' /** Bambara. */ | 'BM' /** Bangla. */ | 'BN' /** Tibetan. */ | 'BO' /** Breton. */ | 'BR' /** Bosnian. */ | 'BS' /** Catalan. */ | 'CA' /** Chechen. */ | 'CE' /** Central Kurdish. */ | 'CKB' /** Czech. */ | 'CS' /** Church Slavic. */ | 'CU' /** Welsh. */ | 'CY' /** Danish. */ | 'DA' /** German. */ | 'DE' /** Dzongkha. */ | 'DZ' /** Ewe. */ | 'EE' /** Greek. */ | 'EL' /** English. */ | 'EN' /** Esperanto. */ | 'EO' /** Spanish. */ | 'ES' /** Estonian. */ | 'ET' /** Basque. */ | 'EU' /** Persian. */ | 'FA' /** Fulah. */ | 'FF' /** Finnish. */ | 'FI' /** Filipino. */ | 'FIL' /** Faroese. */ | 'FO' /** French. */ | 'FR' /** Western Frisian. */ | 'FY' /** Irish. */ | 'GA' /** Scottish Gaelic. */ | 'GD' /** Galician. */ | 'GL' /** Gujarati. */ | 'GU' /** Manx. */ | 'GV' /** Hausa. */ | 'HA' /** Hebrew. */ | 'HE' /** Hindi. */ | 'HI' /** Croatian. */ | 'HR' /** Hungarian. */ | 'HU' /** Armenian. */ | 'HY' /** Interlingua. */ | 'IA' /** Indonesian. */ | 'ID' /** Igbo. */ | 'IG' /** Sichuan Yi. */ | 'II' /** Icelandic. */ | 'IS' /** Italian. */ | 'IT' /** Japanese. */ | 'JA' /** Javanese. */ | 'JV' /** Georgian. */ | 'KA' /** Kikuyu. */ | 'KI' /** Kazakh. */ | 'KK' /** Kalaallisut. */ | 'KL' /** Khmer. */ | 'KM' /** Kannada. */ | 'KN' /** Korean. */ | 'KO' /** Kashmiri. */ | 'KS' /** Kurdish. */ | 'KU' /** Cornish. */ | 'KW' /** Kyrgyz. */ | 'KY' /** Luxembourgish. */ | 'LB' /** Ganda. */ | 'LG' /** Lingala. */ | 'LN' /** Lao. */ | 'LO' /** Lithuanian. */ | 'LT' /** Luba-Katanga. */ | 'LU' /** Latvian. */ | 'LV' /** Malagasy. */ | 'MG' /** Māori. */ | 'MI' /** Macedonian. */ | 'MK' /** Malayalam. */ | 'ML' /** Mongolian. */ | 'MN' /** Marathi. */ | 'MR' /** Malay. */ | 'MS' /** Maltese. */ | 'MT' /** Burmese. */ | 'MY' /** Norwegian (Bokmål). */ | 'NB' /** North Ndebele. */ | 'ND' /** Nepali. */ | 'NE' /** Dutch. */ | 'NL' /** Norwegian Nynorsk. */ | 'NN' /** Norwegian. */ | 'NO' /** Oromo. */ | 'OM' /** Odia. */ | 'OR' /** Ossetic. */ | 'OS' /** Punjabi. */ | 'PA' /** Polish. */ | 'PL' /** Pashto. */ | 'PS' /** Portuguese. */ | 'PT' /** Portuguese (Brazil). */ | 'PT_BR' /** Portuguese (Portugal). */ | 'PT_PT' /** Quechua. */ | 'QU' /** Romansh. */ | 'RM' /** Rundi. */ | 'RN' /** Romanian. */ | 'RO' /** Russian. */ | 'RU' /** Kinyarwanda. */ | 'RW' /** Sanskrit. */ | 'SA' /** Sardinian. */ | 'SC' /** Sindhi. */ | 'SD' /** Northern Sami. */ | 'SE' /** Sango. */ | 'SG' /** Sinhala. */ | 'SI' /** Slovak. */ | 'SK' /** Slovenian. */ | 'SL' /** Shona. */ | 'SN' /** Somali. */ | 'SO' /** Albanian. */ | 'SQ' /** Serbian. */ | 'SR' /** Sundanese. */ | 'SU' /** Swedish. */ | 'SV' /** Swahili. */ | 'SW' /** Tamil. */ | 'TA' /** Telugu. */ | 'TE' /** Tajik. */ | 'TG' /** Thai. */ | 'TH' /** Tigrinya. */ | 'TI' /** Turkmen. */ | 'TK' /** Tongan. */ | 'TO' /** Turkish. */ | 'TR' /** Tatar. */ | 'TT' /** Uyghur. */ | 'UG' /** Ukrainian. */ | 'UK' /** Urdu. */ | 'UR' /** Uzbek. */ | 'UZ' /** Vietnamese. */ | 'VI' /** Volapük. */ | 'VO' /** Wolof. */ | 'WO' /** Xhosa. */ | 'XH' /** Yiddish. */ | 'YI' /** Yoruba. */ | 'YO' /** Chinese. */ | 'ZH' /** Chinese (Simplified). */ | 'ZH_CN' /** Chinese (Traditional). */ | 'ZH_TW' /** Zulu. */ | 'ZU'; /** An object representing a product marked as a fee, aggregated by title. */ export type LegacyAggregatedMerchandiseTermsAsFees = Node & { __typename?: 'LegacyAggregatedMerchandiseTermsAsFees'; /** The description of the fee line, as provided by the _legacy_product_as_fee_description line item property. */ description?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The title of the fee line, as provided by the _legacy_product_as_fee_title line item property. */ title: Scalars['String']['output']; /** The total value of all the products with the same title. */ total: MoneyV2; }; /** A single line item in an order. */ export type LineItem = Node & { __typename?: 'LineItem'; /** The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies. */ currentTotalPrice?: Maybe; /** The list of custom attributes associated with the line item. */ customAttributes: Array; /** The discounts that have been allocated onto the line item by discount applications. */ discountAllocations: Array; /** The discount information for the line item. */ discountInformation: Array; /** Whether the line item represents the purchase of a gift card. */ giftCard: Scalars['Boolean']['output']; /** The line item group associated to the line item. */ group?: Maybe; /** The title of the line item group associated with the line item. */ groupTitle?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The image object associated with the line item. */ image?: Maybe; /** Whether this is line item is marked as a fee. */ legacyFee: Scalars['Boolean']['output']; /** The fee's description, if this line item has been marked as a fee. */ legacyFeeDescription?: Maybe; /** The fee's title, if this line item has been marked as a fee. */ legacyFeeTitle?: Maybe; /** The name of the product. */ name: Scalars['String']['output']; /** The title of the line item variant. */ presentmentTitle?: Maybe; /** The product variant price without any discounts applied, in presentment currencies. */ price?: Maybe; /** The product's ID. */ productId?: Maybe; /** The product's type. */ productType?: Maybe; /** The number of variant items ordered. */ quantity: Scalars['Int']['output']; /** The quantity of the line item, minus the refunded quantity. */ refundableQuantity: Scalars['Int']['output']; /** Whether physical shipping is required for the variant. */ requiresShipping: Scalars['Boolean']['output']; /** The selling plan details associated with the line item. */ sellingPlan?: Maybe; /** The SKU number of the variant. */ sku?: Maybe; /** The discounts that have been allocated onto the line item, ignoring returns. */ soldDiscountInformation: Array; /** The total price of the line item, ignoring returns, with discounts included. */ soldDiscountedTotalPrice?: Maybe; /** The quantity of sold line item, ignoring returns. */ soldQuantity?: Maybe; /** The total price of the line item, ignoring returns, before discounts. */ soldTotalPrice?: Maybe; /** Return reasons suggested based on the line item's product category in Shopify's product taxonomy. These are a curated subset of the full library of available reasons via the [`returnReasonDefinitions`](https://shopify.dev/docs/api/admin-graphql/latest/queries/returnReasonDefinitions) query. */ suggestedReturnReasonDefinitions?: Maybe; /** * The reasons that the customer can return this line item. * @deprecated Use `suggestedReturnReasonDefinitions` instead. */ supportedReturnReasons: Array; /** The title of the product or variant. This field only applies to custom line items. */ title: Scalars['String']['output']; /** The total of the discount allocations on this line item, resulting from discounts applied specifically to this line item. */ totalDiscount: MoneyV2; /** The total price of the line item, calculated by multiplying the current unit price of the variant by the quantity, expressed in presentment currencies. */ totalPrice?: Maybe; /** The total price of the line item, calculated by multiplying the unit price of the variant (before any discounts) by the quantity, expressed in presentment currencies. */ totalPriceBeforeDiscounts?: Maybe; /** The total price of the line item, calculated by multiplying the unit price of the variant (after line item discounts) by the quantity, expressed in presentment currencies. */ totalPriceWithDiscounts?: Maybe; /** The unit price of the line item in presentment currencies. */ unitPrice?: Maybe; /** The ID of the variant. */ variantId?: Maybe; /** The options of the product variant. */ variantOptions?: Maybe>; /** The name of the variant. */ variantTitle?: Maybe; /** The product's vendor. */ vendor?: Maybe; }; /** A single line item in an order. */ export type LineItemSuggestedReturnReasonDefinitionsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** An auto-generated type for paginating through multiple LineItems. */ export type LineItemConnection = { __typename?: 'LineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in LineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** The information about the line item category for the order. */ export type LineItemContainer = | RemainingLineItemContainer | UnfulfilledDigitalLineItemContainer | UnfulfilledGiftCardLineItemContainer | UnfulfilledLineItemContainer | UnfulfilledPhysicalLineItemContainer; /** The information about the line item in the line item container. */ export type LineItemContainerLineItem = Node & { __typename?: 'LineItemContainerLineItem'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The line item associated with the container. */ lineItem: LineItem; /** The number of units yet to be fulfilled. */ remainingQuantity: Scalars['Int']['output']; /** The total number of units in this fulfillment. */ totalQuantity: Scalars['Int']['output']; }; /** An auto-generated type for paginating through multiple LineItemContainerLineItems. */ export type LineItemContainerLineItemConnection = { __typename?: 'LineItemContainerLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in LineItemContainerLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one LineItemContainerLineItem and a cursor during pagination. */ export type LineItemContainerLineItemEdge = { __typename?: 'LineItemContainerLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of LineItemContainerLineItemEdge. */ node: LineItemContainerLineItem; }; /** The discount information for a specific line item. */ export type LineItemDiscountInformation = { __typename?: 'LineItemDiscountInformation'; /** The value of the applied discount. */ discountValue: MoneyV2; /** The discount's name that displays to merchants in the Shopify admin and to customers. */ title?: Maybe; }; /** An auto-generated type which holds one LineItem and a cursor during pagination. */ export type LineItemEdge = { __typename?: 'LineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of LineItemEdge. */ node: LineItem; }; /** A line item group to which a line item belongs to. */ export type LineItemGroup = Node & { __typename?: 'LineItemGroup'; /** The total price of the line item group, calculated by aggregating the current total price of its line item components. */ currentTotalPrice?: Maybe; /** * Whether the group merchandise is itself deliverable. * @deprecated Use `is_concrete` instead. */ deliverable?: Maybe; /** The discount information for the line item group. */ discountInformation?: Maybe>; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The image of the line item group variant or the product image if the variant has no image. */ image?: Maybe; /** Whether the group represents concrete merchandise (as opposed to virtual merchandise). */ isConcrete?: Maybe; /** ID of the parent line item. */ parentLineItemId?: Maybe; /** The title of the parent variant. */ parentVariantTitle?: Maybe; /** The number of line item groups ordered. */ quantity: Scalars['Int']['output']; /** The title of the line item group. */ title: Scalars['String']['output']; /** The total price of the line item group, calculated by aggregating the total price before discounts of its line item components. */ totalPriceBeforeDiscounts?: Maybe; }; /** The selling plan for a line item. */ export type LineItemSellingPlan = { __typename?: 'LineItemSellingPlan'; /** The name of the selling plan for display purposes. */ name: Scalars['String']['output']; /** The ID of the selling plan associated with the line item. */ sellingPlanId?: Maybe; }; /** The line item's variant option. */ export type LineItemVariantOption = { __typename?: 'LineItemVariantOption'; /** The name of the option. */ name: Scalars['String']['output']; /** The value of the option. */ value: Scalars['String']['output']; }; /** Captures the intentions of a discount that was manually created. */ export type ManualDiscountApplication = DiscountApplication & { __typename?: 'ManualDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The description of the application. */ description?: Maybe; /** The lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ title: Scalars['String']['output']; /** The value of the discount application. */ value: PricingValue; }; /** * A market, which is a group of one or more regions targeted for international sales. * A market allows configuration of a distinct, localized shopping experience for customers from a specific area of the world. */ export type Market = Node & { __typename?: 'Market'; /** The short, human-readable unique identifier for the market. */ handle: Scalars['String']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** * The web presence of the market, defining its SEO strategy. This can be a different domain, * subdomain, or subfolders of the primary domain. Each web presence comprises one or more * language variants. If a market doesn't have its own web presence, an inherited web presence will be returned. */ webPresence?: Maybe; }; /** * The web presence of the market, defining its SEO strategy. This can be a different domain * (e.g. `example.ca`), subdomain (e.g. `ca.example.com`), or subfolders of the primary * domain (e.g. `example.com/en-ca`). Each web presence comprises one or more language * variants. If a market does not have its own web presence, it is accessible on the shop’s * primary domain via [country * selectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector). * * Note: while the domain/subfolders defined by a market’s web presence are not applicable to * custom storefronts, which must manage their own domains and routing, the languages chosen * here do govern [the languages available on the Storefront * API](https://shopify.dev/custom-storefronts/internationalization/multiple-languages) for the countries in * this market. */ export type MarketWebPresence = Node & { __typename?: 'MarketWebPresence'; /** * The domain of the web presence. * This field will be null if `subfolderSuffix` isn't null. */ domain?: Maybe; /** A globally-unique identifier. */ id: Scalars['ID']['output']; /** The list of root URLs for each of the web presence’s locales. */ rootUrls: Array; /** The market-specific suffix of the subfolders defined by the web presence. Example: in `/en-us` the subfolder suffix is `us`. This field will be null if `domain` isn't null. */ subfolderSuffix?: Maybe; }; /** The URL for the homepage of the online store in the context of a particular market and a particular locale. */ export type MarketWebPresenceRootUrl = { __typename?: 'MarketWebPresenceRootUrl'; /** The locale in which the storefront loads. */ locale: Scalars['String']['output']; /** The URL of the homepage. */ url: Scalars['URL']['output']; }; /** Represents a media interface. */ export type Media = { /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The preview image for the media. */ previewImage?: Maybe; }; /** The content types that a media can have. */ export type MediaContentType = /** A Shopify hosted generic file. */ | 'GENERIC_FILE' /** A Shopify hosted image. */ | 'IMAGE' /** A Shopify hosted 3D model. */ | 'MODEL_3D' /** A Shopify hosted video. */ | 'VIDEO'; /** Represents a Shopify hosted image. */ export type MediaImage = Media & { __typename?: 'MediaImage'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The image for the media. */ image?: Maybe; /** The media content type. */ mediaContentType: MediaContentType; /** The preview image for the media. */ previewImage?: Maybe; }; /** * The custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. */ export type Metafield = HasCompareDigest & Node & { __typename?: 'Metafield'; /** The data stored in the resource, represented as a digest. */ compareDigest: Scalars['String']['output']; /** The date and time when the metafield was created. */ createdAt: Scalars['DateTime']['output']; /** * The description of a metafield. * @deprecated This field will be removed in a future release. Use the `description` on the metafield definition instead. * */ description?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The data stored in the metafield in JSON format. */ jsonValue: Scalars['JSON']['output']; /** The key name for a metafield. */ key: Scalars['String']['output']; /** The namespace for a metafield. */ namespace: Scalars['String']['output']; /** Returns a reference object if the metafield's type is a resource reference. */ reference?: Maybe; /** A list of reference objects if the metafield's type is a resource reference list. */ references?: Maybe; /** * The type name of the metafield. * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). */ type: Scalars['String']['output']; /** The date and time when the metafield was updated. */ updatedAt: Scalars['DateTime']['output']; /** The value of a metafield. */ value: Scalars['String']['output']; }; /** * The custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. */ export type MetafieldReferencesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; }; /** Identifies a metafield by its owner resource, namespace, and key. */ export type MetafieldIdentifier = { __typename?: 'MetafieldIdentifier'; /** The key of the metafield. */ key: Scalars['String']['output']; /** The namespace of the metafield. */ namespace: Scalars['String']['output']; /** GID of the owner resource that the metafield belongs to. */ ownerId: Scalars['ID']['output']; }; /** The input fields that identify metafields. */ export type MetafieldIdentifierInput = { /** The key of the metafield. */ key: Scalars['String']['input']; /** The namespace of the metafield. */ namespace: Scalars['String']['input']; /** The unique ID of the resource that the metafield is attached to. */ ownerId: Scalars['ID']['input']; }; /** Returns the resource which is being referred to by a metafield. */ export type MetafieldReference = | GenericFile | MediaImage | Metaobject | Model3d | Video; /** An auto-generated type for paginating through multiple MetafieldReferences. */ export type MetafieldReferenceConnection = { __typename?: 'MetafieldReferenceConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in MetafieldReferenceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one MetafieldReference and a cursor during pagination. */ export type MetafieldReferenceEdge = { __typename?: 'MetafieldReferenceEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of MetafieldReferenceEdge. */ node: MetafieldReference; }; /** Value type to describe the Metafield value. */ export type MetafieldValueType = /** A boolean metafield. */ | 'BOOLEAN' /** A float. */ | 'FLOAT' /** An integer. */ | 'INTEGER' /** A JSON string. */ | 'JSON_STRING' /** A string. */ | 'STRING'; /** Return type for `metafieldsDelete` mutation. */ export type MetafieldsDeletePayload = { __typename?: 'MetafieldsDeletePayload'; /** List of metafield identifiers that were deleted, null if the corresponding metafield isn't found. */ deletedMetafields?: Maybe>>; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of `MetafieldsDelete`. */ export type MetafieldsDeleteUserError = DisplayableError & { __typename?: 'MetafieldsDeleteUserError'; /** The error code. */ code?: Maybe; /** The index of the array element that's causing the error. */ elementIndex?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `MetafieldsDeleteUserError`. */ export type MetafieldsDeleteUserErrorCode = /** The input value is blank. */ | 'BLANK' /** Owner type can't be used in this mutation. */ | 'DISALLOWED_OWNER_TYPE' /** The input value is invalid. */ | 'INVALID' /** The metafield delete operation failed. */ | 'METAFIELD_DELETE_FAILED' /** The record with the ID used as the input value couldn't be found. */ | 'NOT_FOUND'; /** The input fields for a metafield value to set. */ export type MetafieldsSetInput = { /** The `compareDigest` value obtained from a previous query. Provide this with updates to ensure the metafield is modified safely. */ compareDigest?: InputMaybe; /** * The unique identifier for a metafield within its namespace. * Must be 2-64 characters long and can contain alphanumeric, hyphen, and underscore characters. */ key: Scalars['String']['input']; /** * The container for a group of metafields that the metafield is or will be associated with. Used in tandem * with `key` to lookup a metafield on a resource, preventing conflicts with other metafields with the * same `key`. * Must be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters. */ namespace: Scalars['String']['input']; /** The unique ID of the resource that the metafield is attached to. */ ownerId: Scalars['ID']['input']; /** * The type of data that is stored in the metafield. * The type must be one of the [supported types](https://shopify.dev/apps/metafields/types). * Required when there is no corresponding definition for the given `namespace`, `key`, and * owner resource type (derived from `ownerId`). */ type?: InputMaybe; /** The data stored in the metafield. Always stored as a string, regardless of the metafield's type. */ value: Scalars['String']['input']; }; /** Return type for `metafieldsSet` mutation. */ export type MetafieldsSetPayload = { __typename?: 'MetafieldsSetPayload'; /** The list of metafields that were set. */ metafields?: Maybe>; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of `MetafieldsSet`. */ export type MetafieldsSetUserError = DisplayableError & { __typename?: 'MetafieldsSetUserError'; /** The error code. */ code?: Maybe; /** The index of the array element that's causing the error. */ elementIndex?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `MetafieldsSetUserError`. */ export type MetafieldsSetUserErrorCode = /** ApiPermission metafields can only be created or updated by the app owner. */ | 'APP_NOT_AUTHORIZED' /** The input value is blank. */ | 'BLANK' /** Owner type can't be used in this mutation. */ | 'DISALLOWED_OWNER_TYPE' /** The input value isn't included in the list. */ | 'INCLUSION' /** The input value is invalid. */ | 'INVALID' /** The compareDigest is invalid. */ | 'INVALID_COMPARE_DIGEST' /** The type is invalid. */ | 'INVALID_TYPE' /** The value is invalid for metafield type or for definition options. */ | 'INVALID_VALUE' /** The input value should be less than or equal to the maximum value allowed. */ | 'LESS_THAN_OR_EQUAL_TO' /** The input value needs to be blank. */ | 'PRESENT' /** The metafield has been modified since it was loaded. */ | 'STALE_OBJECT' /** The input value is already taken. */ | 'TAKEN' /** The input value is too long. */ | 'TOO_LONG' /** The input value is too short. */ | 'TOO_SHORT'; /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type Metaobject = Node & { __typename?: 'Metaobject'; /** Accesses a field of the object by key. */ field?: Maybe; /** * All object fields with defined values. * Omitted object keys can be assumed null, and no guarantees are made about field order. */ fields: Array; /** The unique handle of the metaobject. Useful as a custom ID. */ handle: Scalars['String']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The type of the metaobject. */ type: Scalars['String']['output']; /** The date and time when the metaobject was last updated. */ updatedAt: Scalars['DateTime']['output']; }; /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type MetaobjectFieldArgs = { key: Scalars['String']['input']; }; /** Provides the value of a Metaobject field. */ export type MetaobjectField = { __typename?: 'MetaobjectField'; /** The field key. */ key: Scalars['String']['output']; /** A referenced object if the field type is a resource reference. */ reference?: Maybe; /** * The type name of the field. * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). */ type: Scalars['String']['output']; /** The field value. */ value?: Maybe; }; /** Represents a Shopify hosted 3D model. */ export type Model3d = Media & { __typename?: 'Model3d'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The preview image for the media. */ previewImage?: Maybe; /** The sources for a 3d model. */ sources: Array; }; /** Represents a source for a Shopify hosted 3d model. */ export type Model3dSource = { __typename?: 'Model3dSource'; /** The filesize of the 3d model. */ filesize: Scalars['Int']['output']; /** The format of the 3d model. */ format: Scalars['String']['output']; /** The MIME type of the 3d model. */ mimeType: Scalars['String']['output']; /** The URL of the 3d model. */ url: Scalars['String']['output']; }; /** A collection of monetary values in their respective currencies. Used throughout the API for multi-currency pricing and transactions, when an amount in the shop's currency is converted to the customer's currency of choice. The `presentmentMoney` field contains the amount in the customer's selected currency. The `shopMoney` field contains the equivalent in the shop's base currency. */ export type MoneyBag = { __typename?: 'MoneyBag'; /** Amount in presentment currency. */ presentmentMoney: MoneyV2; /** Amount in shop currency. */ shopMoney: MoneyV2; }; /** A precise monetary value and its associated currency. Combines a decimal amount with a three-letter currency code to express prices, costs, and other financial values throughout the API. For example, 12.99 USD. */ export type MoneyV2 = { __typename?: 'MoneyV2'; /** * A monetary value in decimal format, allowing for precise representation of cents or fractional * currency. For example, 12.99. */ amount: Scalars['Decimal']['output']; /** * The three-letter currency code that represents a world currency used in a store. Currency codes * include standard [standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, * and non-standard codes. For example, USD. */ currencyCode: CurrencyCode; }; /** This is the schema's entry point for all mutation operations. */ export type Mutation = { __typename?: 'Mutation'; /** Adds a new credit card using Apple Pay. */ applePayCreditCardAdd?: Maybe; /** Updates a credit card using Apple Pay. */ applePayCreditCardUpdate?: Maybe; /** Creates a new Apple Pay session. */ applePaySessionCreate?: Maybe; /** Updates the information for a business contact. */ businessContactUpdate?: Maybe; /** Adds a new credit card to the available payment methods of a customer. */ businessLocationCreditCardAdd?: Maybe; /** Updates the details of a credit card for a customer. */ businessLocationCreditCardUpdate?: Maybe; /** Removes a payment instrument from a customer. */ businessLocationPaymentInstrumentRemove?: Maybe; /** Updates an address on a company location. */ companyLocationAssignAddress?: Maybe; /** Adds a new credit card to a customer's list of available payment methods. */ creditCardAdd?: Maybe; /** Updates the details of a customer's credit card. */ creditCardUpdate?: Maybe; /** Creates a new address for a customer. */ customerAddressCreate?: Maybe; /** Deletes a specific address for a customer. */ customerAddressDelete?: Maybe; /** Updates a specific address for a customer. */ customerAddressUpdate?: Maybe; /** Subscribes the customer's email to marketing. */ customerEmailMarketingOptIn?: Maybe; /** Subscribes the customer to email marketing. */ customerEmailMarketingSubscribe?: Maybe; /** Unsubscribes the customer from email marketing. */ customerEmailMarketingUnsubscribe?: Maybe; /** Updates the customer's personal information. */ customerUpdate?: Maybe; /** Adds a new credit card by using Google Pay. */ googlePayCreditCardAdd?: Maybe; /** Updates a credit card using Google Pay. */ googlePayCreditCardUpdate?: Maybe; /** Deletes multiple metafields in bulk. */ metafieldsDelete?: Maybe; /** * Sets metafield values. Metafield values will be set regardless if they were previously created or not. * * Allows a maximum of 25 metafields to be set at a time. * * This operation is atomic, meaning no changes are persisted if an error is encountered. * * As of `2024-07`, this operation supports compare-and-set functionality to better handle concurrent requests. * If `compareDigest` is set for any metafield, the mutation will only set that metafield if the persisted metafield value matches the digest used on `compareDigest`. * If the metafield doesn't exist yet, but you want to guarantee that the operation will run in a safe manner, set `compareDigest` to `null`. * The `compareDigest` value can be acquired by querying the metafield object and selecting `compareDigest` as a field. * If the `compareDigest` value does not match the digest for the persisted value, the mutation will return an error. * You can opt out of write guarantees by not sending `compareDigest` in the request. */ metafieldsSet?: Maybe; /** Request a new return on behalf of a customer. */ orderRequestReturn?: Maybe; /** Adds a new payment instrument and associates mandates. Returns the created instrument on success. */ paymentInstrumentAdd?: Maybe; /** Removes a payment instrument from a customer's account. */ paymentInstrumentRemove?: Maybe; /** Replace existing payment mandates with a new (or existing) instrument. Subscriptions require special treatment. */ paymentInstrumentReplace?: Maybe; /** Updates a customer's default payment instrument. */ paymentInstrumentUpdateDefault?: Maybe; /** Connects a customer's PayPal account for use as a payment method. */ paypalAccountEnable?: Maybe; /** Creates a PayPal Express token. */ paypalTokenCreate?: Maybe; /** Resends a gift card to the customer. */ resendGiftCard?: Maybe; /** Provides a URL that enables the customer to update a Shop Pay credit card. */ shopPayCreditCardGetUpdateUrl?: Maybe; /** * Exchanges the Customer Access Token, provided in the Authorization header, into a Storefront Customer Access Token. * Renew this token each time you update the Customer Access Token found in the Authorization header. * @deprecated The `storefrontCustomerAccessTokenCreate` is deprecated and will be removed in a future version. Please see [the changelog](https://shopify.dev/changelog/deprecation-of-storefrontcustomeraccesstokencreate-mutation) for more information. */ storefrontCustomerAccessTokenCreate?: Maybe; /** Initiates a new Stripe Financial Connections session. */ stripeFinancialConnectionsSessionInitiate?: Maybe; /** Skips a Subscription Billing Cycle. */ subscriptionBillingCycleSkip?: Maybe; /** Unskips a Subscription Billing Cycle. */ subscriptionBillingCycleUnskip?: Maybe; /** Activates a Subscription Contract. Contract status must be either active, paused, or failed. */ subscriptionContractActivate?: Maybe; /** Cancels a Subscription Contract. */ subscriptionContractCancel?: Maybe; /** Changes the payment instrument used for future billing cycles of a Subscription Contract. */ subscriptionContractChangePaymentInstrument?: Maybe; /** Fetches the available delivery options for a Subscription Contract. */ subscriptionContractFetchDeliveryOptions?: Maybe; /** Pauses a Subscription Contract. */ subscriptionContractPause?: Maybe; /** Selects an option from a delivery options result and updates the delivery method on a Subscription Contract. */ subscriptionContractSelectDeliveryMethod?: Maybe; }; /** This is the schema's entry point for all mutation operations. */ export type MutationApplePayCreditCardAddArgs = { applePayTokenizedCard: Scalars['String']['input']; billingAddress: ApplePayBillingAddressInput; displayLastDigits?: InputMaybe; }; /** This is the schema's entry point for all mutation operations. */ export type MutationApplePayCreditCardUpdateArgs = { applePayTokenizedCard: Scalars['String']['input']; billingAddress: ApplePayBillingAddressInput; displayLastDigits?: InputMaybe; paymentMethodId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationApplePaySessionCreateArgs = { resourceId: Scalars['String']['input']; validationUrl: Scalars['String']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationBusinessContactUpdateArgs = { companyId?: InputMaybe; input: BusinessContactUpdateInput; }; /** This is the schema's entry point for all mutation operations. */ export type MutationBusinessLocationCreditCardAddArgs = { billingAddress: CustomerMailingAddressInput; companyLocationId: Scalars['ID']['input']; sessionId: Scalars['String']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationBusinessLocationCreditCardUpdateArgs = { billingAddress: CustomerMailingAddressInput; companyLocationId: Scalars['ID']['input']; paymentMethodId: Scalars['ID']['input']; sessionId: Scalars['String']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationBusinessLocationPaymentInstrumentRemoveArgs = { companyLocationId: Scalars['ID']['input']; paymentInstrumentId: Scalars['ID']['input']; replacementPaymentInstrumentId?: InputMaybe; }; /** This is the schema's entry point for all mutation operations. */ export type MutationCompanyLocationAssignAddressArgs = { address: CompanyAddressInput; addressTypes: Array; locationId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationCreditCardAddArgs = { billingAddress: CustomerMailingAddressInput; default?: InputMaybe; sessionId: Scalars['String']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationCreditCardUpdateArgs = { billingAddress: CustomerMailingAddressInput; paymentMethodId: Scalars['ID']['input']; sessionId: Scalars['String']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationCustomerAddressCreateArgs = { address: CustomerAddressInput; defaultAddress?: InputMaybe; }; /** This is the schema's entry point for all mutation operations. */ export type MutationCustomerAddressDeleteArgs = { addressId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationCustomerAddressUpdateArgs = { address?: InputMaybe; addressId: Scalars['ID']['input']; defaultAddress?: InputMaybe; }; /** This is the schema's entry point for all mutation operations. */ export type MutationCustomerUpdateArgs = { input: CustomerUpdateInput; }; /** This is the schema's entry point for all mutation operations. */ export type MutationGooglePayCreditCardAddArgs = { billingAddress: GooglePayBillingAddressInput; googlePayTokenizedCard: Scalars['String']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationGooglePayCreditCardUpdateArgs = { billingAddress: GooglePayBillingAddressInput; googlePayTokenizedCard: Scalars['String']['input']; paymentMethodId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationMetafieldsDeleteArgs = { metafields: Array; }; /** This is the schema's entry point for all mutation operations. */ export type MutationMetafieldsSetArgs = { metafields: Array; }; /** This is the schema's entry point for all mutation operations. */ export type MutationOrderRequestReturnArgs = { orderId: Scalars['ID']['input']; requestedLineItems: Array; }; /** This is the schema's entry point for all mutation operations. */ export type MutationPaymentInstrumentAddArgs = { idempotencyKey: Scalars['String']['input']; instrument: PaymentInstrumentInput; mandates: Array; }; /** This is the schema's entry point for all mutation operations. */ export type MutationPaymentInstrumentRemoveArgs = { paymentInstrumentId: Scalars['ID']['input']; replacementPaymentInstrumentId?: InputMaybe; }; /** This is the schema's entry point for all mutation operations. */ export type MutationPaymentInstrumentReplaceArgs = { id: Scalars['ID']['input']; idempotencyKey: Scalars['String']['input']; instrument: PaymentInstrumentInput; mandates?: InputMaybe>; }; /** This is the schema's entry point for all mutation operations. */ export type MutationPaymentInstrumentUpdateDefaultArgs = { default: Scalars['Boolean']['input']; paymentInstrumentId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationPaypalAccountEnableArgs = { paypalPayerId: Scalars['String']['input']; paypalToken: Scalars['String']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationResendGiftCardArgs = { orderId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationShopPayCreditCardGetUpdateUrlArgs = { paymentMethodId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionBillingCycleSkipArgs = { billingCycleInput: SubscriptionBillingCycleInput; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionBillingCycleUnskipArgs = { billingCycleInput: SubscriptionBillingCycleInput; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionContractActivateArgs = { subscriptionContractId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionContractCancelArgs = { subscriptionContractId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionContractChangePaymentInstrumentArgs = { paymentInstrumentId: Scalars['ID']['input']; subscriptionContractId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionContractFetchDeliveryOptionsArgs = { address?: InputMaybe; deliveryAddress?: InputMaybe; subscriptionContractId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionContractPauseArgs = { subscriptionContractId: Scalars['ID']['input']; }; /** This is the schema's entry point for all mutation operations. */ export type MutationSubscriptionContractSelectDeliveryMethodArgs = { deliveryMethodInput: SubscriptionDeliveryMethodInput; subscriptionContractId: Scalars['ID']['input']; subscriptionDeliveryOptionsResultToken: Scalars['String']['input']; }; /** * An object with an ID field to support global identification, in accordance with the * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. */ export type Node = { /** A globally-unique ID. */ id: Scalars['ID']['output']; }; /** A line item with at least one unit that is not eligible for return. */ export type NonReturnableLineItem = { __typename?: 'NonReturnableLineItem'; /** The line item associated with the non-returnable units. */ lineItem: LineItem; /** The number of units that aren't eligible for return. */ quantity: Scalars['Int']['output']; /** Details about non-returnable quantities, including the number of units that can't be returned and the reasons they can't be returned, grouped by reason (e.g., already returned, not yet fulfilled). */ quantityDetails: Array; }; /** An auto-generated type for paginating through multiple NonReturnableLineItems. */ export type NonReturnableLineItemConnection = { __typename?: 'NonReturnableLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in NonReturnableLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one NonReturnableLineItem and a cursor during pagination. */ export type NonReturnableLineItemEdge = { __typename?: 'NonReturnableLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of NonReturnableLineItemEdge. */ node: NonReturnableLineItem; }; /** * Details about non-returnable quantities, including the number of units that can't be returned * and the reasons for non-returnability, grouped by reason (e.g., already returned, not yet fulfilled). */ export type NonReturnableQuantityDetail = { __typename?: 'NonReturnableQuantityDetail'; /** The number of units that aren't eligible for return. */ quantity: Scalars['Int']['output']; /** The reason why this quantity isn't eligible for return. */ reasonCode: NonReturnableReason; }; /** The reason why a line item quantity can't be returned. */ export type NonReturnableReason = /** The line item quantity is final sale. This is only applicable if return rules were in place at the time an order was placed. */ | 'FINAL_SALE' /** The line item quantity is ineligible for return for a reason that has not been predefined. */ | 'OTHER' /** The line item quantity has already been returned. */ | 'RETURNED' /** The return window for this line item quantity has expired. This is only applicable if return rules were in place at the time an order was placed. */ | 'RETURN_WINDOW_EXPIRED' /** The line item quantity has not been fulfilled by the merchant. */ | 'UNFULFILLED'; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type Order = HasMetafields & Node & { __typename?: 'Order'; /** A list of sales agreements associated with the order. */ agreements: SalesAgreementConnection; /** The mailing address provided by the customer. Not all orders have a mailing address. */ billingAddress?: Maybe; /** The reason for the cancellation of the order. Returns `null` if the order wasn't canceled. */ cancelReason?: Maybe; /** * The date and time when the order was canceled. * Returns `null` if the order wasn't canceled. */ cancelledAt?: Maybe; /** The checkout token associated with this order. */ checkoutToken?: Maybe; /** * A randomly generated alpha-numeric identifier for the order that may be shown to the customer * instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ". * This value isn't guaranteed to be unique. */ confirmationNumber?: Maybe; /** The date and time when the order was created. */ createdAt: Scalars['DateTime']['output']; /** The shop currency when the order was placed. */ currencyCode: CurrencyCode; /** The list of custom attributes associated with the order. */ customAttributes: Array; /** The customer who placed the order. */ customer?: Maybe; /** The locale code representing the region where this specific order was placed. */ customerLocale?: Maybe; /** The discounts that have been applied to the order. */ discountApplications: DiscountApplicationConnection; /** The discount information for the order, including line-level discount applications. */ discountInformation: OrderDiscountInformation; /** The draft order associated with the order. */ draftOrder?: Maybe; /** The name of the associated draft order. */ draftOrderName?: Maybe; /** The edit summary of the order. */ editSummary?: Maybe; /** Whether the order has been edited or not. */ edited: Scalars['Boolean']['output']; /** The email address of the customer. */ email?: Maybe; /** The financial status of the order. */ financialStatus?: Maybe; /** The fulfillment status of the order. */ fulfillmentStatus: OrderFulfillmentStatus; /** The fulfillments associated with the order. */ fulfillments: FulfillmentConnection; /** Whether the customer has an email address. */ hasEmail: Scalars['Boolean']['output']; /** Whether the order has multiple fulfillments. */ hasMultipleFulfillments: Scalars['Boolean']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The delivery or estimated delivery date of the latest fulfillment. */ latestFulfillmentDeliveryDate?: Maybe; /** The merchandise lines marked as fees with total value, aggregated by title. */ legacyAggregatedMerchandiseTermsAsFees: Array; /** Whether or not products marked as fees should be rendered as money lines. */ legacyRepresentProductsAsFees: Scalars['Boolean']['output']; /** The price of the order before duties, shipping, taxes, and fees. */ legacySubtotalWithoutFees?: Maybe; /** The list of the order's line item containers (e.g., Unfulfilled). */ lineItemContainers: Array; /** The list of line items of the order. */ lineItems: LineItemConnection; /** The summary of the quantity of line items for the order. */ lineItemsSummary?: Maybe; /** The name of the fulfillment location assigned at the time of order creation. */ locationName?: Maybe; /** * The market that includes the order's shipping address. Or the shop's primary market if the shipping address is empty. * @deprecated This `market` field will be removed in a future version of the API. */ market: Market; /** A metafield found by namespace and key. */ metafield?: Maybe; /** * The metafields associated with the resource matching the * supplied list of namespaces and keys. */ metafields: Array>; /** * The identifier for the order that appears on the order. * For example, _#1000_ or _Store1001. */ name: Scalars['String']['output']; /** The order's notes. */ note?: Maybe; /** A unique numeric identifier for the order, used by both the shop owner and customer. */ number: Scalars['Int']['output']; /** The list of metafields associated with the order receipt. */ orderReceiptMetafields: Array; /** The payment information for the order. */ paymentInformation?: Maybe; /** Represents the merchant configured payment terms. */ paymentTermsTemplate?: Maybe; /** The phone number of the customer for SMS notifications. */ phone?: Maybe; /** The pickup information for the order. */ pickupInformation?: Maybe; /** The purchase order number of the order. */ poNumber?: Maybe; /** * The date and time when the order was processed. * This value can be set to dates in the past when importing from other systems. * If no value is provided, it will be auto-generated based on current date and time. */ processedAt: Scalars['DateTime']['output']; /** The purchasing entity for the order. */ purchasingEntity?: Maybe; /** A list of refunds associated with the order. */ refunds: Array; /** The path to recreate the order in the cart and redirect to checkout. Will return nil if the line item count exceeds 100. */ reorderPath?: Maybe; /** Whether the order requires shipping. */ requiresShipping: Scalars['Boolean']['output']; /** A Return identified by ID. */ return?: Maybe; /** The return information for the order. */ returnInformation: OrderReturnInformation; /** The list of returns for the order with pagination. */ returns: ReturnConnection; /** The mailing address to which the order items are shipped. */ shippingAddress?: Maybe; /** The discounts that have been allocated onto the shipping line by discount applications. */ shippingDiscountAllocations: Array; /** A summary of all shipping costs on the order. */ shippingLine?: Maybe; /** The list of shipping line groups for the order. */ shippingLineGroups: Array; /** A summary of the shipping titles for the order. */ shippingTitle?: Maybe; /** The various fields for subscribing to order updates via Shop Pay. */ shopAppLinksAndResources?: Maybe; /** The totals and quantities for the order, ignoring returns. */ soldInformation: OrderSoldInformation; /** The unique URL for the status page of the order. */ statusPageUrl: Scalars['URL']['output']; /** The customer Subscription Contracts associated with the order. */ subscriptionContracts?: Maybe; /** The price of the order before duties, shipping, and taxes. */ subtotal?: Maybe; /** The price of the order before order-level discounts, duties, shipping. It includes taxes in tax-inclusive orders. */ subtotalBeforeDiscounts?: Maybe; /** A list of tax invoices associated with the order. */ taxInvoices: Array; /** The total cost of shipping after discounts. */ totalDiscountedShipping: MoneyV2; /** The total amount of duties after returns. */ totalDuties?: Maybe; /** The total duties and duties status. */ totalDutiesSummary?: Maybe; /** The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned. */ totalPrice: MoneyV2; /** The total amount refunded. */ totalRefunded: MoneyV2; /** The total cost of shipping. */ totalShipping: MoneyV2; /** The total cost of taxes. */ totalTax?: Maybe; /** The total value of tips. */ totalTip?: Maybe; /** A list of transactions associated with the order. */ transactions: Array; /** The date and time when the order was last updated. */ updatedAt: Scalars['DateTime']['output']; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderAgreementsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderDiscountApplicationsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderFulfillmentsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderMetafieldArgs = { key: Scalars['String']['input']; namespace: Scalars['String']['input']; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderMetafieldsArgs = { identifiers: Array; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderReturnArgs = { id: Scalars['ID']['input']; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderReturnsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ export type OrderSubscriptionContractsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** * The possible order action types for a * [sales agreement](https://shopify.dev/api/admin-graphql/latest/interfaces/salesagreement). */ export type OrderActionType = /** An order with a purchase or charge. */ | 'ORDER' /** An edit to the order. */ | 'ORDER_EDIT' /** A refund on the order. */ | 'REFUND' /** A return on the order. */ | 'RETURN' /** An unknown agreement action. Represents new actions that may be added in future versions. */ | 'UNKNOWN'; /** An agreement associated with an order placement. */ export type OrderAgreement = Node & SalesAgreement & { __typename?: 'OrderAgreement'; /** The date and time when the agreement occurred. */ happenedAt: Scalars['DateTime']['output']; /** The unique ID for the agreement. */ id: Scalars['ID']['output']; /** The order associated with the agreement. */ order: Order; /** The reason the agreement was created. */ reason: OrderActionType; /** The sales associated with the agreement. */ sales: SaleConnection; }; /** An agreement associated with an order placement. */ export type OrderAgreementSalesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The information about all discounts applied to a specific order. */ export type OrderAllDiscounts = { __typename?: 'OrderAllDiscounts'; /** The type of the discount application. */ discountApplicationType: DiscountApplicationType; /** The value of the applied discount. */ discountValue: MoneyV2; /** The type of line to which the discount applies. */ targetType: DiscountApplicationTargetType; /** The discount's name that displays to merchants in the Shopify admin and to customers. */ title?: Maybe; }; /** The set of valid sort keys for the OrderByCompany query. */ export type OrderByCompanySortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID' /** Sort by the `order_number` value. */ | 'ORDER_NUMBER' /** Sort by the `processed_at` value. */ | 'PROCESSED_AT' /** Sort by the `total_price` value. */ | 'TOTAL_PRICE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** The set of valid sort keys for the OrderByContact query. */ export type OrderByContactSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID' /** Sort by the `order_number` value. */ | 'ORDER_NUMBER' /** Sort by the `processed_at` value. */ | 'PROCESSED_AT' /** Sort by the `purchasing_company_location_name` value. */ | 'PURCHASING_COMPANY_LOCATION_NAME' /** Sort by the `total_price` value. */ | 'TOTAL_PRICE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** The set of valid sort keys for the OrderByLocation query. */ export type OrderByLocationSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID' /** Sort by the `order_number` value. */ | 'ORDER_NUMBER' /** Sort by the `processed_at` value. */ | 'PROCESSED_AT' /** Sort by the `total_price` value. */ | 'TOTAL_PRICE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** The reason for the cancellation of the order. */ export type OrderCancelReason = /** The customer wanted to cancel the order. */ | 'CUSTOMER' /** Payment was declined. */ | 'DECLINED' /** The order was fraudulent. */ | 'FRAUD' /** There was insufficient inventory. */ | 'INVENTORY' /** The order was canceled for an unlisted reason. */ | 'OTHER' /** Staff made an error. */ | 'STAFF'; /** An auto-generated type for paginating through multiple Orders. */ export type OrderConnection = { __typename?: 'OrderConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in OrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** The disount information for a specific order. */ export type OrderDiscountInformation = { __typename?: 'OrderDiscountInformation'; /** The discount information for the order, including line_level discount applications. */ allAppliedDiscounts: Array; /** The order level discount information for the order. */ allOrderLevelAppliedDiscounts: Array; /** The order level discount information for the order. */ allOrderLevelAppliedDiscountsOnSoldItems: Array; /** Total discounts for the order. */ totalDiscounts: MoneyV2; /** The current order-level discount amount after all order updates. */ totalOrderLevelAppliedDiscounts: MoneyV2; }; /** The status of duties for the order. */ export type OrderDutiesStatusType = /** The order is being shipped from another country, so duties and taxes may be charged on delivery. */ | 'DUTIES_ERROR' /** The order is being shipped from another country, so duties have been added to the order total. */ | 'DUTIES_OK' /** The order is being shipped from another country. Duties are not charged on orders of this value. */ | 'DUTIES_ZERO'; /** The summary of duties associated with an order. */ export type OrderDutiesSummary = { __typename?: 'OrderDutiesSummary'; /** The total amount of duties for the order. */ totalDuties?: Maybe; /** The status of duties for the order. */ totalDutiesStatus?: Maybe; }; /** An auto-generated type which holds one Order and a cursor during pagination. */ export type OrderEdge = { __typename?: 'OrderEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of OrderEdge. */ node: Order; }; /** An agreement related to an edit of the order. */ export type OrderEditAgreement = Node & SalesAgreement & { __typename?: 'OrderEditAgreement'; /** The date and time when the agreement occurred. */ happenedAt: Scalars['DateTime']['output']; /** The unique ID for the agreement. */ id: Scalars['ID']['output']; /** The reason the agreement was created. */ reason: OrderActionType; /** The sales associated with the agreement. */ sales: SaleConnection; }; /** An agreement related to an edit of the order. */ export type OrderEditAgreementSalesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The edit summary associated with an order. */ export type OrderEditSummary = { __typename?: 'OrderEditSummary'; /** The edit changes of the order. */ changes: Array; /** The date and time of the latest edit. */ latestHappenedAt?: Maybe; }; /** A change in the edit summary of an order. */ export type OrderEditSummaryChange = Node & { __typename?: 'OrderEditSummaryChange'; /** The quantity delta of the change. */ delta: Scalars['Int']['output']; /** The handle that describes the change type. */ handle?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The line item associated with the change. */ lineItem: LineItem; }; /** Represents the order's current financial status. */ export type OrderFinancialStatus = /** Displayed as **Authorized**. */ | 'AUTHORIZED' /** Displayed as **Expired**. */ | 'EXPIRED' /** Displayed as **Paid**. */ | 'PAID' /** Displayed as **Partially paid**. */ | 'PARTIALLY_PAID' /** Displayed as **Partially refunded**. */ | 'PARTIALLY_REFUNDED' /** Displayed as **Pending**. */ | 'PENDING' /** Displayed as **Refunded**. */ | 'REFUNDED' /** Displayed as **Voided**. */ | 'VOIDED'; /** Represents the order's aggregated fulfillment status for display purposes. */ export type OrderFulfillmentStatus = /** Displayed as **Fulfilled**. All of the items in the order have been fulfilled. */ | 'FULFILLED' /** Displayed as **In progress**. All of the items in the order have had a request for fulfillment sent to the fulfillment service or all of the items have been marked as in progress. */ | 'IN_PROGRESS' /** Displayed as **On hold**. All of the unfulfilled items in this order are on hold. */ | 'ON_HOLD' /** Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. */ | 'OPEN' /** Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. */ | 'PARTIALLY_FULFILLED' /** Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by "IN_PROGRESS" status. */ | 'PENDING_FULFILLMENT' /** Displayed as **Ready for delivery**. */ | 'READY_FOR_DELIVERY' /** Displayed as **Ready for pickup**. */ | 'READY_FOR_PICKUP' /** Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by "UNFULFILLED" status. */ | 'RESTOCKED' /** Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. */ | 'SCHEDULED' /** Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. */ | 'UNFULFILLED'; /** The quantitative information about the line items of a specific order. */ export type OrderLineItemsSummary = { __typename?: 'OrderLineItemsSummary'; /** The number of line items in the order. */ lineItemCount: Scalars['Int']['output']; /** The total quantity of all legacy fees in the order. */ totalQuantityOfLegacyFeesLineItems: Scalars['Int']['output']; /** The total quantity of all line items in the order. */ totalQuantityOfLineItems: Scalars['Int']['output']; /** The total quantity of all tips in the order. */ totalQuantityOfTipLineItems: Scalars['Int']['output']; }; /** The summary of reasons why the order is ineligible for return. */ export type OrderNonReturnableSummary = { __typename?: 'OrderNonReturnableSummary'; /** Distinct reasons why line items in the order are ineligible for return. */ nonReturnableReasons: Array; /** A message displayed to the customer summarizing why the order is ineligible for return. */ summaryMessage?: Maybe; }; /** The summary of payment status information for the order. */ export type OrderPaymentInformation = { __typename?: 'OrderPaymentInformation'; /** The URL for collecting a payment on the order. */ paymentCollectionUrl?: Maybe; /** The financial status of the order. */ paymentStatus?: Maybe; /** The payment terms linked with the order. */ paymentTerms?: Maybe; /** The total amount that's yet to be transacted for the order. */ totalOutstandingAmount: MoneyV2; /** The total amount that has been paid for the order before any refund. */ totalPaidAmount: MoneyV2; }; /** The current payment status of the order. */ export type OrderPaymentStatus = /** The payment has been authorized. */ | 'AUTHORIZED' /** The payment has expired. */ | 'EXPIRED' /** The payment has been paid. */ | 'PAID' /** The payment has been partially paid. */ | 'PARTIALLY_PAID' /** The payment has been partially refunded. */ | 'PARTIALLY_REFUNDED' /** The payment is pending. */ | 'PENDING' /** The payment has been refunded. */ | 'REFUNDED' /** The payment has been voided. */ | 'VOIDED'; /** The pickup information associated with an order. */ export type OrderPickupInformation = { __typename?: 'OrderPickupInformation'; /** The pickup address for the order. */ address?: Maybe; /** The date and time when the pickup order was created. */ createdAt?: Maybe; /** The pickup status for the order. */ status?: Maybe; /** The date and time when the pickup order was updated. */ updatedAt?: Maybe; }; /** Return type for `orderRequestReturn` mutation. */ export type OrderRequestReturnPayload = { __typename?: 'OrderRequestReturnPayload'; /** The return request that has been made. */ return?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The return information for a specific order. */ export type OrderReturnInformation = { __typename?: 'OrderReturnInformation'; /** Whether the order has one or more restocking fees associated with its returnable line items. */ hasRestockingFee: Scalars['Boolean']['output']; /** Whether the order has one or more return promises associated with any of its line items. */ hasReturnPromise: Scalars['Boolean']['output']; /** Whether the order has one or more return shipping fees associated with its returnable line items. */ hasReturnShippingFee: Scalars['Boolean']['output']; /** The line items that are not eligible for return. */ nonReturnableLineItems: NonReturnableLineItemConnection; /** The summary of reasons why the order is ineligible for return. */ nonReturnableSummary?: Maybe; /** The subtotal of all fees associated with return processing that have been applied to the order (e.g. return shipping fees or restocking fees), aggregated by fee type. */ returnFees: Array; /** * Note for the buyer about the return shipping method. Possible values are: "merchant_provided_label", * "no_shipping_required", or a localized message that the buyer is responsible for return shipping. */ returnShippingMethodNote?: Maybe; /** A set of return shipping methods associated with the order's returnable line items. Return shipping methods are defined by the return rules at the time the order is placed. */ returnShippingMethods: Array; /** The line items that are eligible for return. */ returnableLineItems: ReturnableLineItemConnection; }; /** The return information for a specific order. */ export type OrderReturnInformationNonReturnableLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The return information for a specific order. */ export type OrderReturnInformationReturnableLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The group including the shipping lines of the order. */ export type OrderShippingLineGroup = { __typename?: 'OrderShippingLineGroup'; /** The type of the shipping group. */ groupType: DeliveryOptionGroupType; /** The price of the shipping method after discounts. */ lineAmountAfterDiscounts: MoneyV2; }; /** A summary that regroups totals for an order, including the line items that have been returned. */ export type OrderSoldInformation = { __typename?: 'OrderSoldInformation'; /** The total quantity of line items in the order, including the quantities for line items that have been returned. */ quantity: Scalars['Int']['output']; /** The total quantity of line items in the order that were refunded, even if the totalRefunded amount was zero. */ refundedQuantity: Scalars['Int']['output']; /** The total amount of the order (before shipping and discounts), including the amounts for line items that have been returned. */ subtotal?: Maybe; /** The total amount of the order (including taxes and discounts), including the amounts for line items that have been returned. */ total?: Maybe; /** The total discount amount for the order, including the amounts for line items that have been returned. */ totalDiscount?: Maybe; /** The total tax amount of the order, including the amounts for line items that have been returned. */ totalTaxes?: Maybe; }; /** The set of valid sort keys for the Order query. */ export type OrderSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID' /** Sort by the `order_number` value. */ | 'ORDER_NUMBER' /** Sort by the `processed_at` value. */ | 'PROCESSED_AT' /** Sort by the `total_price` value. */ | 'TOTAL_PRICE' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** A payment transaction within an order context. */ export type OrderTransaction = Node & PaymentIcon & { __typename?: 'OrderTransaction'; /** The date and time when the transaction was created. */ createdAt: Scalars['DateTime']['output']; /** The gift card details for the transaction. */ giftCardDetails?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The kind of the transaction. */ kind?: Maybe; /** The associated order for the transaction. */ order?: Maybe; /** The payment details for the transaction. */ paymentDetails?: Maybe; /** The payment icon to display for the transaction. */ paymentIcon?: Maybe; /** The date and time when the transaction was processed. */ processedAt?: Maybe; /** The status of the transaction. */ status?: Maybe; /** The amount and currency of the transaction in shop and presentment currencies. */ transactionAmount: MoneyBag; /** The ID of the parent transaction. */ transactionParentId?: Maybe; /** The type of the transaction. */ type: OrderTransactionType; /** The details of the transaction type. */ typeDetails?: Maybe; }; /** The kind of order transaction. */ export type OrderTransactionKind = /** An authorization transaction. */ | 'AUTHORIZATION' /** A capture transaction. */ | 'CAPTURE' /** A card approval transaction. */ | 'CARD_APPROVAL' /** A card decline transaction. */ | 'CARD_DECLINE' /** A change transaction. */ | 'CHANGE' /** An EMV authorization transaction. */ | 'EMV_AUTHORIZATION' /** A refund transaction. */ | 'REFUND' /** A refund EMV initiate transaction. */ | 'REFUND_EMV_INITIATE' /** A sale transaction. */ | 'SALE' /** A suggested refund transaction. */ | 'SUGGESTED_REFUND' /** A void transaction. */ | 'VOID'; /** Represents the status of an order transaction. */ export type OrderTransactionStatus = /** The transaction has an error. */ | 'ERROR' /** The transaction has failed. */ | 'FAILURE' /** The transaction is pending. */ | 'PENDING' /** The transaction is pending authentication. */ | 'PENDING_AUTHENTICATION' /** The transaction is successful. */ | 'SUCCESS'; /** The type of order transaction. */ export type OrderTransactionType = /** An ACH bank account transaction. */ | 'ACH' /** A bank deposit transaction. */ | 'BANK_DEPOSIT' /** A card transaction. */ | 'CARD' /** A cash on delivery transaction. */ | 'CASH_ON_DELIVERY' /** A custom payment transaction. */ | 'CUSTOM' /** A gift card transaction. */ | 'GIFT_CARD' /** A generic manual transaction. */ | 'MANUAL' /** A money order transaction. */ | 'MONEY_ORDER' /** A Shopify installments transaction. */ | 'SHOPIFY_INSTALLMENTS' /** A store credit transaction. */ | 'STORE_CREDIT'; /** * Returns information about pagination in a connection, in accordance with the * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). * For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql). */ export type PageInfo = { __typename?: 'PageInfo'; /** The cursor corresponding to the last node in edges. */ endCursor?: Maybe; /** Whether there are more pages to fetch following the current page. */ hasNextPage: Scalars['Boolean']['output']; /** Whether there are any pages prior to the current page. */ hasPreviousPage: Scalars['Boolean']['output']; /** The cursor corresponding to the first node in edges. */ startCursor?: Maybe; }; /** The input fields for a single remote-token credential. */ export type PaymentCredentialRemoteTokenInput = { /** Internal provider identifier. */ providerId?: InputMaybe; /** Opaque credential token. */ token: Scalars['String']['input']; /** Credential type. */ type: Scalars['String']['input']; }; /** Payment details related to a transaction. */ export type PaymentDetails = AchPaymentDetails | CardPaymentDetails; /** The payment icon to display for the transaction. */ export type PaymentIcon = { /** The payment icon to display for the transaction. */ paymentIcon?: Maybe; }; /** Represents an image resource. */ export type PaymentIconImage = Node & { __typename?: 'PaymentIconImage'; /** 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 isn't hosted by Shopify. */ height?: Maybe; /** A unique non-nullable ID for the image. */ id: Scalars['ID']['output']; /** * The location of the original image as a URL. * * If there are any existing transformations in the original source URL, they will remain and not be stripped. * @deprecated Use `url` instead. */ originalSrc: Scalars['URL']['output']; /** * The location of the image as a URL. * @deprecated Use `url` instead. */ src: Scalars['URL']['output']; /** * The ThumbHash of the image. * * Useful to display placeholder images while the original image is loading. */ thumbhash?: Maybe; /** * 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 doesn't support will be ignored. * @deprecated Use `url(transform:)` instead */ transformedSrc: Scalars['URL']['output']; /** * The location of the image as a URL. * * If no transform options are specified, then the original image will be preserved including any pre-applied transforms. * * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. * * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). */ url: Scalars['URL']['output']; /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ width?: Maybe; }; /** Represents an image resource. */ export type PaymentIconImageTransformedSrcArgs = { crop?: InputMaybe; maxHeight?: InputMaybe; maxWidth?: InputMaybe; preferredContentType?: InputMaybe; scale?: InputMaybe; }; /** Represents an image resource. */ export type PaymentIconImageUrlArgs = { transform?: InputMaybe; }; /** A payment instrument. */ export type PaymentInstrument = { /** The list of open draft orders associated with this payment instrument. */ draftOrders: DraftOrderConnection; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The list of pending orders associated with this payment instrument. */ orders: OrderConnection; /** The list of subscription contracts charged using this payment instrument. */ subscriptionContracts: SubscriptionContractConnection; }; /** A payment instrument. */ export type PaymentInstrumentDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A payment instrument. */ export type PaymentInstrumentOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A payment instrument. */ export type PaymentInstrumentSubscriptionContractsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Return type for `paymentInstrumentAdd` mutation. */ export type PaymentInstrumentAddPayload = { __typename?: 'PaymentInstrumentAddPayload'; /** The URL to which the customer should be redirected to complete the 3D Secure payment flow. */ nextActionUrl?: Maybe; /** The newly added payment instrument. */ paymentInstrument?: Maybe< BankPaymentInstrument | CustomerCreditCard | PaypalBillingAgreement >; /** If the payment verification result is processing. When this is true, payment_instrument will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The billing address associated with a credit card payment instrument. */ export type PaymentInstrumentBillingAddress = { __typename?: 'PaymentInstrumentBillingAddress'; /** The first line of the address, typically the street address or PO Box number. */ address1?: Maybe; /** The second line of the address, typically the apartment, suite, or unit number. */ address2?: 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 first name in the address. */ firstName?: Maybe; /** The last name in the address. */ lastName?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** The alphanumeric code for the region, for example, ON. */ provinceCode?: Maybe; /** The zip or postal code of the address. */ zip?: Maybe; }; /** An auto-generated type for paginating through multiple PaymentInstruments. */ export type PaymentInstrumentConnection = { __typename?: 'PaymentInstrumentConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in PaymentInstrumentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array< BankPaymentInstrument | CustomerCreditCard | PaypalBillingAgreement >; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one PaymentInstrument and a cursor during pagination. */ export type PaymentInstrumentEdge = { __typename?: 'PaymentInstrumentEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of PaymentInstrumentEdge. */ node: BankPaymentInstrument | CustomerCreditCard | PaypalBillingAgreement; }; /** The input fields for a payment instrument. */ export type PaymentInstrumentInput = { /** The remote-token based instrument (e.g., credit card session, PayPal token). */ remoteToken?: InputMaybe; }; /** Return type for `paymentInstrumentRemove` mutation. */ export type PaymentInstrumentRemovePayload = { __typename?: 'PaymentInstrumentRemovePayload'; /** The ID of the deleted payment instrument. */ deletedPaymentInstrumentId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `paymentInstrumentReplace` mutation. */ export type PaymentInstrumentReplacePayload = { __typename?: 'PaymentInstrumentReplacePayload'; /** The URL to which the customer should be redirected to complete the 3D Secure payment flow. */ nextActionUrl?: Maybe; /** The replacement payment instrument. */ paymentInstrument?: Maybe< BankPaymentInstrument | CustomerCreditCard | PaypalBillingAgreement >; /** If the payment verification result is processing. When this is true, payment_instrument will be null. */ processing?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `paymentInstrumentUpdateDefault` mutation. */ export type PaymentInstrumentUpdateDefaultPayload = { __typename?: 'PaymentInstrumentUpdateDefaultPayload'; /** The ID of the updated payment instrument. */ updatedPaymentInstrumentId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The types of credit card wallets. */ export type PaymentInstrumentWalletType = /** The credit card is an Apple Pay wallet. */ | 'APPLE_PAY' /** The credit card is a Google Pay wallet. */ | 'GOOGLE_PAY' /** The credit card is a Shop Pay wallet. */ | 'SHOP_PAY'; /** The input fields for a mandate association for a payment instrument. */ export type PaymentMandateInput = { resourceId?: InputMaybe; resourceType: PaymentMandateResourceType; }; /** Resources a mandate can be associated with. */ export type PaymentMandateResourceType = | 'ANY' | 'CHECKOUT' | 'DRAFTORDER' | 'ORDER' | 'RECEIPT' | 'SUBSCRIPTIONS'; /** A payment method that customers can use to pay. */ export type PaymentMethod = BankPaymentMethod; /** Represents a payment provider client credentials. */ export type PaymentProviderClientCredentials = { __typename?: 'PaymentProviderClientCredentials'; /** The API client key for the payment provider client. */ apiClientKey?: Maybe; /** The merchant's payment provider account id. */ merchantAccountId?: Maybe; }; /** A single payment schedule defined in the payment terms. */ export type PaymentSchedule = Node & { __typename?: 'PaymentSchedule'; /** * The amount owed for this payment schedule. * @deprecated Use `totalBalance` instead. */ amount: MoneyV2; /** Whether the payment has been completed. */ completed: Scalars['Boolean']['output']; /** The date and time when the payment schedule was paid or fulfilled. */ completedAt?: Maybe; /** The date and time when the payment schedule is due. */ dueAt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** Remaining balance to be paid or authorized by the customer for this payment schedule. */ totalBalance: MoneyV2; }; /** An auto-generated type for paginating through multiple PaymentSchedules. */ export type PaymentScheduleConnection = { __typename?: 'PaymentScheduleConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in PaymentScheduleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one PaymentSchedule and a cursor during pagination. */ export type PaymentScheduleEdge = { __typename?: 'PaymentScheduleEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of PaymentScheduleEdge. */ node: PaymentSchedule; }; /** The payment terms associated with an order or draft order. */ export type PaymentTerms = Node & { __typename?: 'PaymentTerms'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The next due date if this is the NET or FIXED type of payment terms. */ nextDueAt?: Maybe; /** Whether the payment terms have overdue payment schedules. */ overdue: Scalars['Boolean']['output']; /** The list of schedules associated with the payment terms. */ paymentSchedules: PaymentScheduleConnection; /** The name of the payment terms template that was used to create the payment terms. */ paymentTermsName: Scalars['String']['output']; /** The type of the payment terms template that was used to create the payment terms. */ paymentTermsType: PaymentTermsType; }; /** The payment terms associated with an order or draft order. */ export type PaymentTermsPaymentSchedulesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The template for payment terms. */ export type PaymentTermsTemplate = Node & { __typename?: 'PaymentTermsTemplate'; /** The description of the payment terms template. */ description: Scalars['String']['output']; /** The number of days between the issue date and due date for net-type payment terms. */ dueInDays?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The name of the payment terms template. */ name: Scalars['String']['output']; /** The type of the payment terms template. */ paymentTermsType: PaymentTermsType; /** The translated name of the payment terms template. */ translatedName: Scalars['String']['output']; }; /** The type of a payment terms or a payment terms template. */ export type PaymentTermsType = /** The payment terms or payment terms template is fixed type (due on a specified date). */ | 'FIXED' /** The payment terms or payment terms template is due upon fulfillment. */ | 'FULFILLMENT' /** The payment terms or payment terms template is net type (due a number of days after issue). */ | 'NET' /** The payment terms or payment terms template is due upon receipt. */ | 'RECEIPT' /** The type of the payment terms or payment terms template is unknown. */ | 'UNKNOWN'; /** Return type for `paypalAccountEnable` mutation. */ export type PaypalAccountEnablePayload = { __typename?: 'PaypalAccountEnablePayload'; /** The newly established PayPal billing agreement. */ paypalBillingAgreement?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** A payment method using a PayPal billing agreement. */ export type PaypalBillingAgreement = Node & PaymentInstrument & { __typename?: 'PaypalBillingAgreement'; /** The billing address associated with the payment method. */ billingAddress?: Maybe; /** The list of open draft orders associated with this payment instrument. */ draftOrders: DraftOrderConnection; /** The globally-unique ID. */ id: Scalars['ID']['output']; /** The list of pending orders associated with this payment instrument. */ orders: OrderConnection; /** The email address associated with the PayPal account. */ paypalAccountEmail?: Maybe; /** The list of pending orders associated with this PayPal billing agreement. */ pendingOrders: OrderConnection; /** The list of subscription contracts charged using this PayPal billing agreement. */ subscriptionContracts: SubscriptionContractConnection; }; /** A payment method using a PayPal billing agreement. */ export type PaypalBillingAgreementDraftOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A payment method using a PayPal billing agreement. */ export type PaypalBillingAgreementOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A payment method using a PayPal billing agreement. */ export type PaypalBillingAgreementPendingOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A payment method using a PayPal billing agreement. */ export type PaypalBillingAgreementSubscriptionContractsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Return type for `paypalTokenCreate` mutation. */ export type PaypalTokenCreatePayload = { __typename?: 'PaypalTokenCreatePayload'; /** The created PayPal Express token. */ token?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The operations that can be performed on a B2B resource. */ export type PermittedOperation = /** The permission to add a resource. */ | 'ADD' /** All permissions for a resource. */ | 'ALL' /** The permission to delete a resource. */ | 'DELETE' /** The permission to edit a resource. */ | 'EDIT' /** The permission to use a resource. */ | 'USE' /** The permission to view a resource. */ | 'VIEW'; /** The address of a pickup location. */ export type PickupAddress = { __typename?: 'PickupAddress'; /** The street address for the pickup location. */ address1: Scalars['String']['output']; /** Any additional address information for the pickup location. */ address2?: Maybe; /** The city of the pickup location. */ city: Scalars['String']['output']; /** The country code for the pickup location. */ countryCode: CountryCode; /** The phone number for the pickup location. */ phone?: Maybe; /** The ZIP code for the pickup location. */ zip?: Maybe; /** The province code for the pickup location. */ zoneCode?: Maybe; }; /** The status of the order's pickup. */ export type PickupStatus = /** The pickup of the order has been confirmed. */ | 'CLOSED' /** The order has been picked up. */ | 'IN_PROGRESS' /** The order is ready for pick up. */ | 'OPEN'; /** Represents the value of the percentage pricing object. */ export type PricingPercentageValue = { __typename?: 'PricingPercentageValue'; /** The percentage value of the object. */ percentage: Scalars['Float']['output']; }; /** The price value (fixed or percentage) for a discount application. */ export type PricingValue = MoneyV2 | PricingPercentageValue; /** A sale associated with a product. */ export type ProductSale = Node & Sale & { __typename?: 'ProductSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The line item for the associated sale. */ lineItem: LineItem; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** The information of the purchasing company for an order or draft order. */ export type PurchasingCompany = { __typename?: 'PurchasingCompany'; /** The company associated with the order or draft order. */ company: Company; /** The company contact associated with the order or draft order. */ contact?: Maybe; /** The company location associated with the order or draft order. */ location: CompanyLocation; }; /** Represents information about the purchasing entity for the order or draft order. */ export type PurchasingEntity = Customer | PurchasingCompany; /** This acts as the public, top-level API from which all queries start. */ export type QueryRoot = { __typename?: 'QueryRoot'; /** The information of the customer's company. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ company?: Maybe; /** The Location corresponding to the provided ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ companyLocation?: Maybe; /** Returns the Customer resource. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ customer: Customer; /** Returns a draft order resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ draftOrder?: Maybe; /** The API tokens for UI extensions. */ extensionApiTokens?: Maybe; /** Returns an Order resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ order?: Maybe; /** Returns a Return resource by ID. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ return?: Maybe; /** The calculated monetary value of the return. */ returnCalculate?: Maybe; /** Returns the information about the shop. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */ shop: Shop; /** * Public metafields for Shop, Order, Customer, Company, CompanyLocation, Product, and ProductVariant * for given extension ids. Shop metafields are always fetched if there is a match for the given namespace and key pairs. * Product and ProductVariant are only fetched if resource_ids are provided and there is a match for the * namespace and key. This is restricted to development shops for local UI extension development purposes only. */ uiExtensionMetafields: Array; /** A session token for an UI extension. */ uiExtensionSessionToken?: Maybe; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootCompanyArgs = { id: Scalars['ID']['input']; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootCompanyLocationArgs = { id: Scalars['ID']['input']; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootDraftOrderArgs = { id: Scalars['ID']['input']; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootExtensionApiTokensArgs = { appId: Scalars['ID']['input']; extensionType?: InputMaybe; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootOrderArgs = { id: Scalars['ID']['input']; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootReturnArgs = { id: Scalars['ID']['input']; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootReturnCalculateArgs = { input: CalculateReturnInput; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootUiExtensionMetafieldsArgs = { orderId?: InputMaybe; resourceIds?: InputMaybe>; }; /** This acts as the public, top-level API from which all queries start. */ export type QueryRootUiExtensionSessionTokenArgs = { appId?: InputMaybe; extensionActivationId?: InputMaybe; }; /** The record of refunds issued to a customer. */ export type Refund = Node & { __typename?: 'Refund'; /** The date and time when the refund was created. */ createdAt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The name of the return, if the refund was issued from a return. */ returnName?: Maybe; /** The total amount refunded across all transactions, in presentment currencies. */ totalRefunded: MoneyV2; /** The date and time when the refund was last updated. */ updatedAt: Scalars['DateTime']['output']; }; /** An agreement for refunding all or a portion of the order between the merchant and the customer. */ export type RefundAgreement = Node & SalesAgreement & { __typename?: 'RefundAgreement'; /** The date and time when the agreement occurred. */ happenedAt: Scalars['DateTime']['output']; /** The unique ID for the agreement. */ id: Scalars['ID']['output']; /** The reason the agreement was created. */ reason: OrderActionType; /** The refund that's associated with the agreement. */ refund: Refund; /** The sales associated with the agreement. */ sales: SaleConnection; }; /** An agreement for refunding all or a portion of the order between the merchant and the customer. */ export type RefundAgreementSalesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The information about the line items container for items that have not been refunded or removed. */ export type RemainingLineItemContainer = { __typename?: 'RemainingLineItemContainer'; /** A unique ID for the container. */ id: Scalars['ID']['output']; /** The line items contained within this container. */ lineItems: RemainingLineItemContainerLineItemConnection; }; /** The information about the line items container for items that have not been refunded or removed. */ export type RemainingLineItemContainerLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The information about the line item in the line item container. */ export type RemainingLineItemContainerLineItem = Node & { __typename?: 'RemainingLineItemContainerLineItem'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The line item associated with the container. */ lineItem: LineItem; }; /** An auto-generated type for paginating through multiple RemainingLineItemContainerLineItems. */ export type RemainingLineItemContainerLineItemConnection = { __typename?: 'RemainingLineItemContainerLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in RemainingLineItemContainerLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one RemainingLineItemContainerLineItem and a cursor during pagination. */ export type RemainingLineItemContainerLineItemEdge = { __typename?: 'RemainingLineItemContainerLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of RemainingLineItemContainerLineItemEdge. */ node: RemainingLineItemContainerLineItem; }; /** The input fields for a remote-token instrument. */ export type RemoteTokenPaymentInstrumentInput = { /** The billing address associated with the payment instrument. */ billingAddress?: InputMaybe; /** Credentials for the remote token instrument. Multiple entries may be required for some instrument types. */ credentials: Array; /** The owner ID to associate with this instrument. */ ownerId: Scalars['ID']['input']; }; /** The input fields for a line item requested for return. */ export type RequestedLineItemInput = { /** * A note from the customer explaining the item to be returned. * For instance, the note can detail issues with the item for the merchant's information. * Maximum length: 300 characters. */ customerNote?: InputMaybe; /** The ID of the line item that the customer wants to return. */ lineItemId: Scalars['ID']['input']; /** The quantity of the line item that the customer wants to return. */ quantity: Scalars['Int']['input']; /** The ID of a [`ReturnReasonDefinition`](https://shopify.dev/docs/api/customer/latest/objects/ReturnReasonDefinition). Use [`LineItem.suggestedReturnReasonDefinitions`](https://shopify.dev/docs/api/customer/latest/objects/LineItem#field-LineItem.fields.suggestedReturnReasonDefinitions) to get reasons tailored to the product's category. */ returnReasonDefinitionId?: InputMaybe; }; /** Return type for `resendGiftCard` mutation. */ export type ResendGiftCardPayload = { __typename?: 'ResendGiftCardPayload'; /** The ID of the order that resends the gift cards. */ orderId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Represents permissions on resources. */ export type ResourcePermission = { __typename?: 'ResourcePermission'; /** The operations permitted on the resource. */ permittedOperations: Array; /** The name of the resource. */ resource: ResourceType; }; /** The B2B resource types. */ export type ResourceType = /** The Business Profile resource type. */ | 'BUSINESS_PROFILE' /** The Company resource type. */ | 'COMPANY' /** The Company Contact resource type. */ | 'COMPANY_CONTACT' /** The Company Contact Role resource type. */ | 'COMPANY_CONTACT_ROLE' /** The Company Location resource type. */ | 'COMPANY_LOCATION' /** The Company Location Billing Address resource type. */ | 'COMPANY_LOCATION_BILLING_ADDRESS' /** The Company Location Shipping Address resource type. */ | 'COMPANY_LOCATION_SHIPPING_ADDRESS' /** The Company Tax Exemption resource type. */ | 'COMPANY_TAX_EXEMPTION' /** The Draft Order resource type. */ | 'DRAFT_ORDER' /** The Order resource type. */ | 'ORDER' /** The Payment Method resource type. */ | 'PAYMENT_METHOD'; /** A product return. */ export type Return = Node & { __typename?: 'Return'; /** The date when the return was closed. */ closedAt?: Maybe; /** The date when the return was created. */ createdAt?: Maybe; /** The additional details about why the merchant declined the return request. */ decline?: Maybe; /** The exchange line items attached to the return. */ exchangeLineItems: ExchangeLineItemConnection; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The name assigned to the return. */ name: Scalars['String']['output']; /** The line items associated with the return. */ returnLineItems: ReturnLineItemTypeConnection; /** The number of line items associated with the return. */ returnLineItemsCount?: Maybe; /** The list of reverse deliveries associated with the return. */ reverseDeliveries: ReverseDeliveryConnection; /** The current status of the `Return`. */ status: ReturnStatus; /** The timeline events related to the return. */ timelineEvents: Array; /** The number of line items associated with the return. */ tmpReturnLineItemsCount: Scalars['Int']['output']; /** The date when the return was last updated. */ updatedAt?: Maybe; }; /** A product return. */ export type ReturnExchangeLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; includeRemovedItems?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A product return. */ export type ReturnReturnLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A product return. */ export type ReturnReverseDeliveriesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** An agreement between the merchant and customer for a return. */ export type ReturnAgreement = Node & SalesAgreement & { __typename?: 'ReturnAgreement'; /** The date and time when the agreement occurred. */ happenedAt: Scalars['DateTime']['output']; /** The unique ID for the agreement. */ id: Scalars['ID']['output']; /** The reason the agreement was created. */ reason: OrderActionType; /** The return associated with the agreement. */ return: Return; /** The sales associated with the agreement. */ sales: SaleConnection; }; /** An agreement between the merchant and customer for a return. */ export type ReturnAgreementSalesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** An auto-generated type for paginating through multiple Returns. */ export type ReturnConnection = { __typename?: 'ReturnConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in ReturnEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** The merchant's reason for declining the customer's return request. */ export type ReturnDecline = { __typename?: 'ReturnDecline'; /** The merchant's message to the customer explaining why their return request was declined. */ note?: Maybe; /** The reason the return request was declined. */ reason: ReturnDeclineReason; }; /** The specific reason for the merchant declining a customer's return request. */ export type ReturnDeclineReason = /** The return request was declined because it contains items from a final sale. */ | 'FINAL_SALE' /** The return request was declined due to another reason. */ | 'OTHER' /** The return request was declined because the return period has ended. */ | 'RETURN_PERIOD_ENDED'; /** An auto-generated type which holds one Return and a cursor during pagination. */ export type ReturnEdge = { __typename?: 'ReturnEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of ReturnEdge. */ node: Return; }; /** Possible error codes that can be returned by `ReturnUserError`. */ export type ReturnErrorCode = /** The requested resource already exists. */ | 'ALREADY_EXISTS' /** The input value is blank. */ | 'BLANK' /** A requested resource could not be created. */ | 'CREATION_FAILED' /** The input value should be equal to the value allowed. */ | 'EQUAL_TO' /** A required feature is not enabled. */ | 'FEATURE_NOT_ENABLED' /** The input value should be greater than the minimum allowed value. */ | 'GREATER_THAN' /** The input value should be greater than or equal to the minimum value allowed. */ | 'GREATER_THAN_OR_EQUAL_TO' /** The input value isn't included in the list. */ | 'INCLUSION' /** Unexpected internal error happened. */ | 'INTERNAL_ERROR' /** The input value is invalid. */ | 'INVALID' /** A resource was not in the correct state for the operation to succeed. */ | 'INVALID_STATE' /** The input value should be less than the maximum value allowed. */ | 'LESS_THAN' /** The input value should be less than or equal to the maximum value allowed. */ | 'LESS_THAN_OR_EQUAL_TO' /** A requested notification could not be sent. */ | 'NOTIFICATION_FAILED' /** A request is not authorized. */ | 'NOT_AUTHORIZED' /** The input value is not a number. */ | 'NOT_A_NUMBER' /** A requested item is not editable. */ | 'NOT_EDITABLE' /** A requested item could not be found. */ | 'NOT_FOUND' /** The input value needs to be blank. */ | 'PRESENT' /** The input value is already taken. */ | 'TAKEN' /** The input value is too big. */ | 'TOO_BIG' /** The input value is too long. */ | 'TOO_LONG' /** Too many arguments provided. */ | 'TOO_MANY_ARGUMENTS' /** The input value is too short. */ | 'TOO_SHORT' /** The input value is the wrong length. */ | 'WRONG_LENGTH'; /** A fee associated with the processing of a return. */ export type ReturnFee = { /** The total monetary value of the fee in shop and presentment currencies. */ amountSet: MoneyBag; /** Human-readable name of the fee. */ title: Scalars['String']['output']; }; /** The financial breakdown of the return. */ export type ReturnFinancialSummary = { __typename?: 'ReturnFinancialSummary'; /** The subtotal of all return line items restocking fees. */ restockingFeeSubtotalSet: MoneyBag; /** The sum of all order level discounts that are target_all?. */ returnOrderLevelDiscountSubtotalSet: MoneyBag; /** The subtotal of all return line items shipping fees. */ returnShippingFeeSubtotalSet: MoneyBag; /** The subtotal of all return line items excluding target_all discounts. */ returnSubtotalBeforeTargetAllDiscountsSet: MoneyBag; /** The subtotal of all return line items. */ returnSubtotalSet: MoneyBag; /** The subtotal of all return line items with order level discounts applied. */ returnSubtotalWithCartDiscountSet: MoneyBag; /** The total sum of all return line items, including return line item subtotals, fees and taxes. */ returnTotalSet: MoneyBag; /** The total tax sum of all return line items. */ returnTotalTaxSet: MoneyBag; }; /** A line item that has been returned. */ export type ReturnLineItem = Node & ReturnLineItemType & { __typename?: 'ReturnLineItem'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The related line item that has been returned. */ lineItem: LineItem; /** The line item quantity that has been returned. */ quantity: Scalars['Int']['output']; /** The reason the line item quantity was returned. */ returnReason: ReturnReason; /** The standardized reason for why the item is being returned. */ returnReasonDefinition?: Maybe; }; /** A line item that has been returned. */ export type ReturnLineItemType = { /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The specific line item that's being returned. */ lineItem: LineItem; /** The quantity of the line item that's been returned. */ quantity: Scalars['Int']['output']; /** * The reason for returning the line item. * @deprecated Use `returnReasonDefinition` instead. This field will be removed in the future. */ returnReason: ReturnReason; /** The standardized reason for why the item is being returned. */ returnReasonDefinition?: Maybe; }; /** An auto-generated type for paginating through multiple ReturnLineItemTypes. */ export type ReturnLineItemTypeConnection = { __typename?: 'ReturnLineItemTypeConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in ReturnLineItemTypeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ReturnLineItemType and a cursor during pagination. */ export type ReturnLineItemTypeEdge = { __typename?: 'ReturnLineItemTypeEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of ReturnLineItemTypeEdge. */ node: ReturnLineItem | UnverifiedReturnLineItem; }; /** * The reason for returning the item. * * > **Deprecated**: This enum is deprecated in favor of `ReturnReasonDefinition`. * > Use `returnReasonDefinitionId` in input objects and `returnReasonDefinition` in return line items instead. * > This enum will be removed in a future API version. */ export type ReturnReason = /** The color of the item didn't meet expectations. */ | 'COLOR' /** The item was damaged or defective. */ | 'DEFECTIVE' /** The item was not as described. */ | 'NOT_AS_DESCRIBED' /** Other reason not listed. */ | 'OTHER' /** The size of the item was too large. */ | 'SIZE_TOO_LARGE' /** The size of the item was too small. */ | 'SIZE_TOO_SMALL' /** The style of the item didn't meet expectations. */ | 'STYLE' /** The reason is unknown. */ | 'UNKNOWN' /** The customer changed their mind about the item. */ | 'UNWANTED' /** The customer received the wrong item. */ | 'WRONG_ITEM'; /** * A standardized reason for returning an item. * * - Shopify offers an expanded library of return reasons available to all merchants * - For each product, Shopify suggests a curated subset of reasons based on the product's category. */ export type ReturnReasonDefinition = Node & { __typename?: 'ReturnReasonDefinition'; /** * Whether the return reason has been removed from taxonomy. * * Deleted reasons should not be presented to customers when creating new returns, but may still * appear on existing returns that were created before the reason was deleted. This field enables * graceful deprecation of return reasons without breaking historical data. */ deleted: Scalars['Boolean']['output']; /** * A unique, human-readable, stable identifier for the return reason. * * Example values include "arrived-late", "comfort", "too-tight", "color-too-bright", and "quality". * The handle remains consistent across API versions and localizations, making it suitable for programmatic use. */ handle: Scalars['String']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** * The localized, user-facing name of the return reason. * * This field returns the reason name in the requested locale, automatically falling back to * English if no translation is available. Use this field when displaying return reasons to * customers. */ name: Scalars['String']['output']; }; /** An auto-generated type for paginating through multiple ReturnReasonDefinitions. */ export type ReturnReasonDefinitionConnection = { __typename?: 'ReturnReasonDefinitionConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in ReturnReasonDefinitionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ReturnReasonDefinition and a cursor during pagination. */ export type ReturnReasonDefinitionEdge = { __typename?: 'ReturnReasonDefinitionEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of ReturnReasonDefinitionEdge. */ node: ReturnReasonDefinition; }; /** The restocking fee incurred during the return process. */ export type ReturnRestockingFee = ReturnFee & { __typename?: 'ReturnRestockingFee'; /** The total monetary value of the fee in shop and presentment currencies. */ amountSet: MoneyBag; /** Human-readable name of the fee. */ title: Scalars['String']['output']; }; /** The shipping fee incurred during the return process. */ export type ReturnShippingFee = ReturnFee & { __typename?: 'ReturnShippingFee'; /** The total monetary value of the fee in shop and presentment currencies. */ amountSet: MoneyBag; /** Human-readable name of the fee. */ title: Scalars['String']['output']; }; /** How items will be returned to the merchant. */ export type ReturnShippingMethod = /** The customer is responsible for providing the shipping label. */ | 'CUSTOMER_PROVIDED_LABEL' /** The merchant provides the shipping label. */ | 'MERCHANT_PROVIDED_LABEL'; /** The set of valid sort keys for the Return query. */ export type ReturnSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID'; /** The current status of a `Return`. */ export type ReturnStatus = /** The `Return` has been canceled by the user. */ | 'CANCELED' /** The `Return` has been successfully completed. */ | 'CLOSED' /** The `Return` request was declined. */ | 'DECLINED' /** The `Return` is currently in progress. */ | 'OPEN' /** The `Return` has been requested by the user. */ | 'REQUESTED'; /** The supported reason for returning a line item. */ export type ReturnSupportedReason = { __typename?: 'ReturnSupportedReason'; /** The standardized return reason (e.g. `DEFECTIVE` or `UNWANTED`) for returning the line item. */ reason: ReturnReason; /** The localized, display text for the return reason. */ title: Scalars['String']['output']; }; /** The errors that occur during the execution of a return mutation. */ export type ReturnUserError = DisplayableError & { __typename?: 'ReturnUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** A line item with at least one unit that is eligible for return. */ export type ReturnableLineItem = { __typename?: 'ReturnableLineItem'; /** The related line item. */ lineItem: LineItem; /** The quantity of units that can be returned. */ quantity: Scalars['Int']['output']; }; /** An auto-generated type for paginating through multiple ReturnableLineItems. */ export type ReturnableLineItemConnection = { __typename?: 'ReturnableLineItemConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in ReturnableLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one ReturnableLineItem and a cursor during pagination. */ export type ReturnableLineItemEdge = { __typename?: 'ReturnableLineItemEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of ReturnableLineItemEdge. */ node: ReturnableLineItem; }; /** * A reverse delivery represents a package being sent back by a buyer to a merchant post-fulfillment. * This could occur when a buyer requests a return and the merchant provides a shipping label. * The reverse delivery includes the context of the items being returned, the method of return * (for example, a shipping label), and the current status of the delivery (tracking information). */ export type ReverseDelivery = Node & { __typename?: 'ReverseDelivery'; /** Whether the label was generated by the customer. */ customerGeneratedLabel: Scalars['Boolean']['output']; /** The deliverable linked with the reverse delivery. */ deliverable?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; }; /** An auto-generated type for paginating through multiple ReverseDeliveries. */ export type ReverseDeliveryConnection = { __typename?: 'ReverseDeliveryConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in ReverseDeliveryEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** The method and associated details of a reverse delivery. */ export type ReverseDeliveryDeliverable = ReverseDeliveryShippingDeliverable; /** An auto-generated type which holds one ReverseDelivery and a cursor during pagination. */ export type ReverseDeliveryEdge = { __typename?: 'ReverseDeliveryEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of ReverseDeliveryEdge. */ node: ReverseDelivery; }; /** The return label information for a reverse delivery. */ export type ReverseDeliveryLabel = { __typename?: 'ReverseDeliveryLabel'; /** The date and time when the reverse delivery label was created. */ createdAt: Scalars['DateTime']['output']; /** A publicly accessible link for downloading the label image. */ publicFileUrl?: Maybe; /** The date and time when the reverse delivery label was last updated. */ updatedAt: Scalars['DateTime']['output']; }; /** A set of shipping deliverables for reverse delivery. */ export type ReverseDeliveryShippingDeliverable = { __typename?: 'ReverseDeliveryShippingDeliverable'; /** The return label that's attached to the reverse delivery. */ label?: Maybe; /** The tracking information for the reverse delivery. */ tracking?: Maybe; }; /** The tracking information for a reverse delivery. */ export type ReverseDeliveryTracking = { __typename?: 'ReverseDeliveryTracking'; /** The name of the delivery service provider, in a format that's suitable for display purposes. */ carrierName?: Maybe; /** The identifier that the courier uses to track the shipment. */ trackingNumber?: Maybe; /** The URL used to track the shipment. */ trackingUrl?: Maybe; }; /** * A record of an individual sale associated with a sales agreement. Every monetary value in an order's sales data is represented in the smallest unit of the currency. * When amounts are divided across multiple line items, such as taxes or order discounts, the amounts might not divide evenly across all of the line items on the order. * To address this, the remaining currency units that couldn't be divided evenly are allocated one at a time, starting with the first line item, until they are all accounted for. * In aggregate, the values sum up correctly. In isolation, one line item might have a different tax or discount amount than another line item of the same price, before taxes and discounts. * This is because the amount could not be divided evenly across the items. The allocation of currency units across line items is immutable. After they are allocated, currency units are never reallocated or redistributed among the line items. */ export type Sale = { /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** An order action type associated with a sale. */ export type SaleActionType = /** A purchase or charge. */ | 'ORDER' /** A removal or return. */ | 'RETURN' /** An unidentified order action. Represents new actions that may be added in future versions. */ | 'UNKNOWN' /** A change to the price, taxes, or discounts for a previous purchase. */ | 'UPDATE'; /** An auto-generated type for paginating through multiple Sales. */ export type SaleConnection = { __typename?: 'SaleConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in SaleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array< | AdditionalFeeSale | AdjustmentSale | DutySale | FeeSale | GiftCardSale | ProductSale | ShippingLineSale | TipSale | UnknownSale >; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one Sale and a cursor during pagination. */ export type SaleEdge = { __typename?: 'SaleEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of SaleEdge. */ node: | AdditionalFeeSale | AdjustmentSale | DutySale | FeeSale | GiftCardSale | ProductSale | ShippingLineSale | TipSale | UnknownSale; }; /** * The possible line types of a sale record. A sale can be an adjustment, which occurs when a refund is issued for a line item that is either more or less than the total value of the line item. * Examples include restocking fees and goodwill payments. In such cases, Shopify generates a sales agreement with sale records for each line item that is returned or refunded, and an additional sale record for the adjustment, for example a restocking fee. * The sale records for the returned or refunded items represent the reversal of the original line item sale value. The additional adjustment sale record represents the difference between the original total value of all line items that were refunded, and the actual amount refunded. */ export type SaleLineType = /** An additional fee. */ | 'ADDITIONAL_FEE' /** A sale adjustment. */ | 'ADJUSTMENT' /** A duty charge. */ | 'DUTY' /** A fee charge. */ | 'FEE' /** A gift card. */ | 'GIFT_CARD' /** A product that was purchased, returned, or exchanged. */ | 'PRODUCT' /** A shipping charge. */ | 'SHIPPING' /** A tip given by the customer. */ | 'TIP' /** An unknown sale line type. This represents new types that may be added in future versions. */ | 'UNKNOWN'; /** The tax allocated to a sale from a single tax line. */ export type SaleTax = Node & { __typename?: 'SaleTax'; /** The portion of the total tax amount on the related sale that's from the associated tax line. */ amount: MoneyV2; /** The unique ID for the sale tax. */ id: Scalars['ID']['output']; /** The tax line associated with the sale. */ taxLine: TaxLine; }; /** A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more. */ export type SalesAgreement = { /** The date and time when the agreement occurred. */ happenedAt: Scalars['DateTime']['output']; /** The unique ID for the agreement. */ id: Scalars['ID']['output']; /** The reason the agreement was created. */ reason: OrderActionType; /** The sales associated with the agreement. */ sales: SaleConnection; }; /** A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more. */ export type SalesAgreementSalesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** An auto-generated type for paginating through multiple SalesAgreements. */ export type SalesAgreementConnection = { __typename?: 'SalesAgreementConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in SalesAgreementEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array< OrderAgreement | OrderEditAgreement | RefundAgreement | ReturnAgreement >; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SalesAgreement and a cursor during pagination. */ export type SalesAgreementEdge = { __typename?: 'SalesAgreementEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of SalesAgreementEdge. */ node: OrderAgreement | OrderEditAgreement | RefundAgreement | ReturnAgreement; }; /** Captures the intentions of a discount that was created by a Shopify Script. */ export type ScriptDiscountApplication = DiscountApplication & { __typename?: 'ScriptDiscountApplication'; /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application as defined by the Script. */ title: Scalars['String']['output']; /** The value of the discount application. */ value: PricingValue; }; /** Represents the shipping details that the customer chose for their order. */ export type ShippingLine = { __typename?: 'ShippingLine'; /** A unique identifier for the shipping rate. */ handle?: Maybe; /** The pre-tax shipping price without any discounts applied. */ originalPrice: MoneyV2; /** The title of the shipping line. */ title: Scalars['String']['output']; }; /** A sale associated with a shipping charge. */ export type ShippingLineSale = Node & Sale & { __typename?: 'ShippingLineSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** A shipping rate to be applied to a checkout. */ export type ShippingRate = { __typename?: 'ShippingRate'; /** The human-readable unique identifier for this shipping rate. */ handle: Scalars['String']['output']; /** The price of this shipping rate. */ price: MoneyV2; /** The title of this shipping rate. */ title: Scalars['String']['output']; }; /** A collection of the general information about the shop. */ export type Shop = HasMetafields & Node & { __typename?: 'Shop'; /** Returns the settings for the address form. */ addressFormSettings: AddressFormSettings; /** The email of the shop. */ email: Scalars['String']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** A metafield found by namespace and key. */ metafield?: Maybe; /** * The metafields associated with the resource matching the * supplied list of namespaces and keys. */ metafields: Array>; /** The shop's .myshopify.com domain name. */ myshopifyDomain: Scalars['String']['output']; /** The name of the shop. */ name: Scalars['String']['output']; /** The list of all legal policies associated with the shop. */ shopPolicies: Array; /** The URL of the shop's online store. */ url: Scalars['URL']['output']; }; /** A collection of the general information about the shop. */ export type ShopMetafieldArgs = { key: Scalars['String']['input']; namespace: Scalars['String']['input']; }; /** A collection of the general information about the shop. */ export type ShopMetafieldsArgs = { identifiers: Array; }; /** The shop app links and resources for an order. */ export type ShopAppLinksAndResources = { __typename?: 'ShopAppLinksAndResources'; /** Whether the the buyer is associated to Shop App. */ buyerHasShopApp: Scalars['Boolean']['output']; /** Whether the the buyer is associated to Shop Pay. */ buyerHasShopPay: Scalars['Boolean']['output']; /** Whether or not the track order updates button should be rendered. */ canTrackOrderUpdates: Scalars['Boolean']['output']; /** Whether or not showing the installments highlight is eligible. */ installmentsHighlightEligible: Scalars['Boolean']['output']; /** The URL to the mobile Shop App. */ mobileUrl: Scalars['URL']['output']; /** The attribution details related to the mobile url. */ mobileUrlAttributionPayload: Scalars['String']['output']; /** The various options that exist for subscribing to order updates. */ orderUpdateOptions: Array; /** The URL to the Shop App QR code. */ qrCodeUrl: Scalars['URL']['output']; /** Whether or not Shop App eligible. */ shopAppEligible: Scalars['Boolean']['output']; /** Whether QR code should be hidden. */ shopAppQrCodeKillswitch: Scalars['Boolean']['output']; /** The URL to the Shop Pay Installments reminders. */ shopInstallmentsMobileUrl: Scalars['URL']['output']; /** The URL to view the Shop Pay Installments schedules in the mobile Shop App. */ shopInstallmentsViewSchedules: Scalars['URL']['output']; /** Whether the order was a shop pay order. */ shopPayOrder: Scalars['Boolean']['output']; }; /** Return type for `shopPayCreditCardGetUpdateUrl` mutation. */ export type ShopPayCreditCardGetUpdateUrlPayload = { __typename?: 'ShopPayCreditCardGetUpdateUrlPayload'; /** The URL to which the customer should be redirected to update their Shop Pay credit card. */ updateShopPayCreditCardUrl?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** A policy that a merchant has configured for their store, such as their refund or privacy policy. */ export type ShopPolicy = Node & { __typename?: 'ShopPolicy'; /** The text of the policy. The maximum size is 512kb. */ body: Scalars['HTML']['output']; /** The handle of the policy. */ handle: Scalars['String']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The title of the policy. */ title: Scalars['String']['output']; /** The public URL to the policy. */ url: Scalars['URL']['output']; }; /** Defines the valid SMS marketing states for a customer’s phone number. */ export type SmsMarketingState = /** The customer has not subscribed to SMS marketing. */ | 'NOT_SUBSCRIBED' /** The customer is in the process of subscribing to SMS marketing. */ | 'PENDING' /** The customer's personal data has been erased. This value is internally-set and read-only. */ | 'REDACTED' /** The customer has subscribed to SMS marketing. */ | 'SUBSCRIBED' /** The customer is not currently subscribed to SMS marketing but was previously subscribed. */ | 'UNSUBSCRIBED'; /** * A store credit account contains a monetary balance that can be redeemed at checkout for purchases in the shop. * The account is held in the specified currency and has an owner that cannot be transferred. * * The account balance is redeemable at checkout only when the owner is authenticated via [new customer accounts authentication](https://shopify.dev/docs/api/customer). */ export type StoreCreditAccount = Node & { __typename?: 'StoreCreditAccount'; /** The current balance of the store credit account. */ balance: MoneyV2; /** The expirable part of the store credit account balance. */ expirableBalance: MoneyV2; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The transaction history of the store credit account. */ transactions: StoreCreditAccountTransactionConnection; }; /** * A store credit account contains a monetary balance that can be redeemed at checkout for purchases in the shop. * The account is held in the specified currency and has an owner that cannot be transferred. * * The account balance is redeemable at checkout only when the owner is authenticated via [new customer accounts authentication](https://shopify.dev/docs/api/customer). */ export type StoreCreditAccountTransactionsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; query?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** An auto-generated type for paginating through multiple StoreCreditAccounts. */ export type StoreCreditAccountConnection = { __typename?: 'StoreCreditAccountConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in StoreCreditAccountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** A credit transaction which increases the store credit account balance. */ export type StoreCreditAccountCreditTransaction = Node & StoreCreditAccountTransaction & { __typename?: 'StoreCreditAccountCreditTransaction'; /** The store credit account that the transaction belongs to. */ account: StoreCreditAccount; /** The amount of the transaction. */ amount: MoneyV2; /** The balance of the account after the transaction. */ balanceAfterTransaction: MoneyV2; /** The date and time when the transaction was created. */ createdAt: Scalars['DateTime']['output']; /** The event that caused the store credit account transaction. */ event: StoreCreditSystemEvent; /** * The time at which the transaction expires. * Debit transactions will always spend the soonest expiring credit first. */ expiresAt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The origin of the store credit account transaction. */ origin?: Maybe; /** * The remaining amount of the credit. * The remaining amount will decrease when a debit spends this credit. It may also increase if that debit is subsequently reverted. * In the event that the credit expires, the remaining amount will represent the amount that remained as the expiry ocurred. */ remainingAmount: MoneyV2; }; /** * A debit revert transaction which increases the store credit account balance. * Debit revert transactions are created automatically when a [store credit account debit transaction](https://shopify.dev/api/admin-graphql/latest/objects/StoreCreditAccountDebitTransaction) is reverted. * * Store credit account debit transactions are reverted when an order is cancelled, refunded or in the event of a payment failure at checkout. * The amount added to the balance is equal to the amount reverted on the original credit. */ export type StoreCreditAccountDebitRevertTransaction = Node & StoreCreditAccountTransaction & { __typename?: 'StoreCreditAccountDebitRevertTransaction'; /** The store credit account that the transaction belongs to. */ account: StoreCreditAccount; /** The amount of the transaction. */ amount: MoneyV2; /** The balance of the account after the transaction. */ balanceAfterTransaction: MoneyV2; /** The date and time when the transaction was created. */ createdAt: Scalars['DateTime']['output']; /** The reverted debit transaction. */ debitTransaction: StoreCreditAccountDebitTransaction; /** The event that caused the store credit account transaction. */ event: StoreCreditSystemEvent; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The origin of the store credit account transaction. */ origin?: Maybe; }; /** A debit transaction which decreases the store credit account balance. */ export type StoreCreditAccountDebitTransaction = Node & StoreCreditAccountTransaction & { __typename?: 'StoreCreditAccountDebitTransaction'; /** The store credit account that the transaction belongs to. */ account: StoreCreditAccount; /** The amount of the transaction. */ amount: MoneyV2; /** The balance of the account after the transaction. */ balanceAfterTransaction: MoneyV2; /** The date and time when the transaction was created. */ createdAt: Scalars['DateTime']['output']; /** The event that caused the store credit account transaction. */ event: StoreCreditSystemEvent; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The origin of the store credit account transaction. */ origin?: Maybe; }; /** An auto-generated type which holds one StoreCreditAccount and a cursor during pagination. */ export type StoreCreditAccountEdge = { __typename?: 'StoreCreditAccountEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of StoreCreditAccountEdge. */ node: StoreCreditAccount; }; /** * An expiration transaction which decreases the store credit account balance. * Expiration transactions are created automatically when a [store credit account credit transaction](https://shopify.dev/api/admin-graphql/latest/objects/StoreCreditAccountCreditTransaction) expires. * * The amount subtracted from the balance is equal to the remaining amount of the credit transaction. */ export type StoreCreditAccountExpirationTransaction = StoreCreditAccountTransaction & { __typename?: 'StoreCreditAccountExpirationTransaction'; /** The store credit account that the transaction belongs to. */ account: StoreCreditAccount; /** The amount of the transaction. */ amount: MoneyV2; /** The balance of the account after the transaction. */ balanceAfterTransaction: MoneyV2; /** The date and time when the transaction was created. */ createdAt: Scalars['DateTime']['output']; /** The credit transaction which expired. */ creditTransaction: StoreCreditAccountCreditTransaction; /** The event that caused the store credit account transaction. */ event: StoreCreditSystemEvent; /** The origin of the store credit account transaction. */ origin?: Maybe; }; /** Interface for a store credit account transaction. */ export type StoreCreditAccountTransaction = { /** The store credit account that the transaction belongs to. */ account: StoreCreditAccount; /** The amount of the transaction. */ amount: MoneyV2; /** The balance of the account after the transaction. */ balanceAfterTransaction: MoneyV2; /** The date and time when the transaction was created. */ createdAt: Scalars['DateTime']['output']; /** The event that caused the store credit account transaction. */ event: StoreCreditSystemEvent; /** The origin of the store credit account transaction. */ origin?: Maybe; }; /** An auto-generated type for paginating through multiple StoreCreditAccountTransactions. */ export type StoreCreditAccountTransactionConnection = { __typename?: 'StoreCreditAccountTransactionConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in StoreCreditAccountTransactionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array< | StoreCreditAccountCreditTransaction | StoreCreditAccountDebitRevertTransaction | StoreCreditAccountDebitTransaction | StoreCreditAccountExpirationTransaction >; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one StoreCreditAccountTransaction and a cursor during pagination. */ export type StoreCreditAccountTransactionEdge = { __typename?: 'StoreCreditAccountTransactionEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of StoreCreditAccountTransactionEdge. */ node: | StoreCreditAccountCreditTransaction | StoreCreditAccountDebitRevertTransaction | StoreCreditAccountDebitTransaction | StoreCreditAccountExpirationTransaction; }; /** The origin of a store credit account transaction. */ export type StoreCreditAccountTransactionOrigin = OrderTransaction; /** The event that caused the store credit account transaction. */ export type StoreCreditSystemEvent = /** An adjustment was made to the store credit account. */ | 'ADJUSTMENT' /** Store credit was returned when an authorized payment was voided. */ | 'ORDER_CANCELLATION' /** Store credit was used as payment for an order. */ | 'ORDER_PAYMENT' /** Store credit was refunded from an order. */ | 'ORDER_REFUND' /** A store credit payment was reverted due to another payment method failing. */ | 'PAYMENT_FAILURE' /** A smaller amount of store credit was captured than was originally authorized. */ | 'PAYMENT_RETURNED' /** Tax finalization affected the store credit payment. */ | 'TAX_FINALIZATION'; /** Return type for `storefrontCustomerAccessTokenCreate` mutation. */ export type StorefrontCustomerAccessTokenCreatePayload = { __typename?: 'StorefrontCustomerAccessTokenCreatePayload'; /** The created access token. */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `stripeFinancialConnectionsSessionInitiate` mutation. */ export type StripeFinancialConnectionsSessionInitiatePayload = { __typename?: 'StripeFinancialConnectionsSessionInitiatePayload'; /** The Stripe Financial Connections client secret for session initiation. */ clientSecret?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Represents a subscription anchor. */ export type SubscriptionAnchor = | SubscriptionMonthDayAnchor | SubscriptionWeekDayAnchor | SubscriptionYearDayAnchor; /** The billing cycle of a subscription. */ export type SubscriptionBillingCycle = { __typename?: 'SubscriptionBillingCycle'; /** The expected date of the billing attempt. */ billingAttemptExpectedDate: Scalars['DateTime']['output']; /** The end date of the billing cycle. */ cycleEndAt: Scalars['DateTime']['output']; /** The index of the billing cycle. */ cycleIndex: Scalars['Int']['output']; /** The start date of the billing cycle. */ cycleStartAt: Scalars['DateTime']['output']; /** Whether the billing cycle was edited. */ edited: Scalars['Boolean']['output']; /** Whether the billing cycle was skipped. */ skipped: Scalars['Boolean']['output']; /** The status of the billing cycle. */ status: SubscriptionBillingCycleBillingCycleStatus; }; /** The possible statuses of a subscription billing cycle. */ export type SubscriptionBillingCycleBillingCycleStatus = /** The billing cycle has been billed. */ | 'BILLED' /** The billing cycle has not been billed. */ | 'UNBILLED'; /** An auto-generated type for paginating through multiple SubscriptionBillingCycles. */ export type SubscriptionBillingCycleConnection = { __typename?: 'SubscriptionBillingCycleConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in SubscriptionBillingCycleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SubscriptionBillingCycle and a cursor during pagination. */ export type SubscriptionBillingCycleEdge = { __typename?: 'SubscriptionBillingCycleEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of SubscriptionBillingCycleEdge. */ node: SubscriptionBillingCycle; }; /** The input fields for specifying the subscription contract and selecting the associated billing cycle. */ export type SubscriptionBillingCycleInput = { /** The ID of the subscription contract associated with the billing cycle. */ contractId: Scalars['ID']['input']; /** Selects the billing cycle by date or index. */ selector: SubscriptionBillingCycleSelector; }; /** The input fields to select a SubscriptionBillingCycle by either date or index. */ export type SubscriptionBillingCycleSelector = { /** The date to select a billing cycle. */ date?: InputMaybe; /** The index to select a billing cycle. */ index?: InputMaybe; }; /** Return type for `subscriptionBillingCycleSkip` mutation. */ export type SubscriptionBillingCycleSkipPayload = { __typename?: 'SubscriptionBillingCycleSkipPayload'; /** The updated billing cycle. */ billingCycle?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of `SubscriptionBillingCycleSkip`. */ export type SubscriptionBillingCycleSkipUserError = DisplayableError & { __typename?: 'SubscriptionBillingCycleSkipUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `SubscriptionBillingCycleSkipUserError`. */ export type SubscriptionBillingCycleSkipUserErrorCode = /** The input value is invalid. */ 'INVALID'; /** Return type for `subscriptionBillingCycleUnskip` mutation. */ export type SubscriptionBillingCycleUnskipPayload = { __typename?: 'SubscriptionBillingCycleUnskipPayload'; /** The updated billing cycle. */ billingCycle?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** An error that occurs during the execution of `SubscriptionBillingCycleUnskip`. */ export type SubscriptionBillingCycleUnskipUserError = DisplayableError & { __typename?: 'SubscriptionBillingCycleUnskipUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `SubscriptionBillingCycleUnskipUserError`. */ export type SubscriptionBillingCycleUnskipUserErrorCode = /** The input value is invalid. */ 'INVALID'; /** The set of valid sort keys for the SubscriptionBillingCycles query. */ export type SubscriptionBillingCyclesSortKeys = /** Sort by the `cycle_end_at` value. */ | 'CYCLE_END_AT' /** Sort by the `cycle_index` value. */ | 'CYCLE_INDEX' /** Sort by the `id` value. */ | 'ID'; /** The billing policy of a subscription. */ export type SubscriptionBillingPolicy = { __typename?: 'SubscriptionBillingPolicy'; /** The anchor dates for calculating billing intervals. */ anchors: Array; /** The type of interval associated with this schedule (e.g. Monthly, Weekly, etc). */ interval: SubscriptionInterval; /** The number of intervals between invoices. */ intervalCount?: Maybe; /** The maximum number of cycles after which the subscription ends. */ maxCycles?: Maybe; /** The minimum number of cycles required for the subscription. */ minCycles?: Maybe; }; /** A Subscription Contract. */ export type SubscriptionContract = Node & SubscriptionContractBase & { __typename?: 'SubscriptionContract'; /** The subscription app that the subscription contract is registered to. */ app?: Maybe; /** Whether the subscription contract is eligible for customer actions. */ appEligibleForCustomerActions: Scalars['Boolean']['output']; /** The billing policy associated with the subscription contract. */ billingPolicy: SubscriptionBillingPolicy; /** The date and time when the subscription contract was created. */ createdAt: Scalars['DateTime']['output']; /** The currency used for the subscription contract. */ currencyCode: CurrencyCode; /** A list of custom attributes to be added to the generated orders. */ customAttributes: Array; /** 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?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The last billing error type of the contract. */ lastBillingAttemptErrorType?: Maybe; /** The current status of the last payment. */ lastPaymentStatus?: Maybe; /** The number of lines associated with the subscription contract. */ lineCount: Scalars['Int']['output']; /** A list of subscription lines associated with the subscription contract. */ lines: SubscriptionLineConnection; /** The number of lines associated with the subscription contract. */ linesCount?: Maybe; /** The next billing date for the subscription contract. */ nextBillingDate?: Maybe; /** A note that will be applied to the generated orders. */ note?: Maybe; /** A list of the subscription contract's orders. */ orders: OrderConnection; /** The order from which the contract originated. */ originOrder?: Maybe; /** The payment instrument being charged for this subscription contract. */ paymentInstrument?: Maybe< BankPaymentInstrument | CustomerCreditCard | PaypalBillingAgreement >; /** An estimate of the breakdown of the amounts that will be charged in the next billing attempt. */ priceBreakdownEstimate?: Maybe; /** The revision ID of the contract. */ revisionId: Scalars['UnsignedInt64']['output']; /** The current status of the subscription contract. */ status: SubscriptionContractSubscriptionStatus; /** The upcoming billing cycles on the subscription contract. */ upcomingBillingCycles: SubscriptionBillingCycleConnection; /** The date and time when the subscription contract was updated. */ updatedAt: Scalars['DateTime']['output']; }; /** A Subscription Contract. */ export type SubscriptionContractDiscountsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A Subscription Contract. */ export type SubscriptionContractLinesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A Subscription Contract. */ export type SubscriptionContractOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** A Subscription Contract. */ export type SubscriptionContractUpcomingBillingCyclesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; sortKey?: InputMaybe; }; /** Return type for `subscriptionContractActivate` mutation. */ export type SubscriptionContractActivatePayload = { __typename?: 'SubscriptionContractActivatePayload'; /** The activated Subscription Contract. */ contract?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The common fields of a subscription contract. */ export type SubscriptionContractBase = { /** Whether the subscription contract is eligible for customer actions. */ appEligibleForCustomerActions: Scalars['Boolean']['output']; /** The currency used for the subscription contract. */ currencyCode: CurrencyCode; /** A list of custom attributes to be added to the generated orders. */ customAttributes: Array; /** The delivery method for each billing of the subscription contract. */ deliveryMethod?: Maybe; /** The delivery price for each billing of the subscription contract. */ deliveryPrice: MoneyV2; /** The list of subscription discounts associated with the subscription contract. */ discounts?: Maybe; /** The number of lines associated with the subscription contract. */ lineCount: Scalars['Int']['output']; /** A list of subscription lines associated with the subscription contract. */ lines: SubscriptionLineConnection; /** The number of lines associated with the subscription contract. */ linesCount?: Maybe; /** A note that will be applied to the generated orders. */ note?: Maybe; /** A list of the subscription contract's orders. */ orders: OrderConnection; /** An estimate of the breakdown of the amounts that will be charged in the next billing attempt. */ priceBreakdownEstimate?: Maybe; /** The date and time when the subscription contract was updated. */ updatedAt: Scalars['DateTime']['output']; }; /** The common fields of a subscription contract. */ export type SubscriptionContractBaseDiscountsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The common fields of a subscription contract. */ export type SubscriptionContractBaseLinesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The common fields of a subscription contract. */ export type SubscriptionContractBaseOrdersArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** Return type for `subscriptionContractCancel` mutation. */ export type SubscriptionContractCancelPayload = { __typename?: 'SubscriptionContractCancelPayload'; /** The canceled Subscription Contract. */ contract?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionContractChangePaymentInstrument` mutation. */ export type SubscriptionContractChangePaymentInstrumentPayload = { __typename?: 'SubscriptionContractChangePaymentInstrumentPayload'; /** The updated Subscription Contract after the payment instrument change. */ contract?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** An auto-generated type for paginating through multiple SubscriptionContracts. */ export type SubscriptionContractConnection = { __typename?: 'SubscriptionContractConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in SubscriptionContractEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SubscriptionContract and a cursor during pagination. */ export type SubscriptionContractEdge = { __typename?: 'SubscriptionContractEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of SubscriptionContractEdge. */ node: SubscriptionContract; }; /** Return type for `subscriptionContractFetchDeliveryOptions` mutation. */ export type SubscriptionContractFetchDeliveryOptionsPayload = { __typename?: 'SubscriptionContractFetchDeliveryOptionsPayload'; /** The available delivery options for a given delivery address. Returns `null` for pending requests. */ deliveryOptionsResult?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** The possible values of the last billing error on a subscription contract. */ export type SubscriptionContractLastBillingErrorType = /** Subscription billing attempt error due to customer error. */ | 'CUSTOMER_ERROR' /** Subscription billing attempt error due to inventory error. */ | 'INVENTORY_ERROR' /** All other billing attempt errors. */ | 'OTHER' /** Subscription billing attempt error due to payment error. */ | 'PAYMENT_ERROR'; /** The status of the last payment on a subscription contract. */ export type SubscriptionContractLastPaymentStatus = /** A failed subscription billing attempt. */ | 'FAILED' /** A successful subscription billing attempt. */ | 'SUCCEEDED'; /** Return type for `subscriptionContractPause` mutation. */ export type SubscriptionContractPausePayload = { __typename?: 'SubscriptionContractPausePayload'; /** The updated Subscription Contract after the pause operation. */ contract?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Return type for `subscriptionContractSelectDeliveryMethod` mutation. */ export type SubscriptionContractSelectDeliveryMethodPayload = { __typename?: 'SubscriptionContractSelectDeliveryMethodPayload'; /** The updated subscription contract object. */ contract?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; /** Possible error codes that can be returned by `SubscriptionContractStatusUpdateUserError`. */ export type SubscriptionContractStatusUpdateErrorCode = /** Subscription contract status cannot be changed once failed. */ | 'CONTRACT_FAILED' /** Subscription contract status cannot be changed once terminated. */ | 'CONTRACT_TERMINATED' /** Subscription contract has a future contract or schedule edit. */ | 'HAS_FUTURE_EDITS' /** The input value is invalid. */ | 'INVALID' /** Subscription contract does not exist. */ | 'SUBSCRIPTION_CONTRACT_DOES_NOT_EXIST'; /** The error codes for failed subscription contract mutations. */ export type SubscriptionContractStatusUpdateUserError = DisplayableError & { __typename?: 'SubscriptionContractStatusUpdateUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** The status of a subscription. */ export type SubscriptionContractSubscriptionStatus = /** The contract is active and is continuing per its policies. */ | 'ACTIVE' /** The contract was ended by an unplanned customer action. */ | 'CANCELLED' /** The contract has ended per the expected circumstances. All billing and delivery cycles of the subscriptions have been executed. */ | 'EXPIRED' /** The contract has ended because billing failed and no further billing attempts are expected. */ | 'FAILED' /** The contract is temporarily paused and is expected to resume in the future. */ | 'PAUSED' /** The contract has expired due to inactivity. */ | 'STALE'; /** The error codes for failed subscription contract mutations. */ export type SubscriptionContractUserError = DisplayableError & { __typename?: 'SubscriptionContractUserError'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `SubscriptionContractUserError`. */ export type SubscriptionContractUserErrorCode = /** The input value is blank. */ | 'BLANK' /** Subscription contract has a future contract or schedule edit. */ | 'HAS_FUTURE_EDITS' /** The input value is invalid. */ | 'INVALID' /** Payment instrument does not exist. */ | 'PAYMENT_INSTRUMENT_DOES_NOT_EXIST' /** Subscription contract does not exist. */ | 'SUBSCRIPTION_CONTRACT_DOES_NOT_EXIST'; /** The set of valid sort keys for the SubscriptionContracts query. */ export type SubscriptionContractsSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `id` value. */ | 'ID' /** Sort by the `status` value. */ | 'STATUS' /** Sort by the `updated_at` value. */ | 'UPDATED_AT'; /** The delivery method to use to deliver the physical goods to the customer. */ export type SubscriptionDeliveryMethod = | SubscriptionDeliveryMethodLocalDelivery | SubscriptionDeliveryMethodPickup | SubscriptionDeliveryMethodShipping; /** * Specifies delivery method fields for a subscription contract. * 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. */ export type SubscriptionDeliveryMethodInput = { /** The input fields for the local delivery method. */ localDelivery?: InputMaybe; /** The input fields for the pickup delivery method. */ pickup?: InputMaybe; /** The input fields for the shipping delivery method. */ shipping?: InputMaybe; }; /** The local delivery method, including a mailing address and a local delivery option. */ export type SubscriptionDeliveryMethodLocalDelivery = { __typename?: 'SubscriptionDeliveryMethodLocalDelivery'; /** The delivery address. */ address: SubscriptionMailingAddress; /** The local delivery method details. */ localDeliveryOption: SubscriptionDeliveryMethodLocalDeliveryOption; }; /** The input fields for a local delivery method. */ export type SubscriptionDeliveryMethodLocalDeliveryInput = { /** The address to deliver to. */ address?: InputMaybe; /** The address to deliver to. */ deliveryAddress?: InputMaybe; /** The delivery instructions that the customer can provide to the merchant. */ instructions?: InputMaybe; /** * The phone number that the customer must provide to the merchant. * Formatted using E.164 standard. For example, `+16135551111`. */ phone: Scalars['String']['input']; }; /** The delivery option selected for a subscription contract. */ export type SubscriptionDeliveryMethodLocalDeliveryOption = { __typename?: 'SubscriptionDeliveryMethodLocalDeliveryOption'; /** The description of the delivery option shown to the customer. */ description?: Maybe; /** The delivery instructions provided by the customer to the merchant. */ instructions?: Maybe; /** * The phone number of the customer provided to the merchant. * Formatted using E.164 standard. For example, `+16135551111`. */ phone: Scalars['String']['output']; /** The displayed title of the delivery option. */ presentmentTitle?: Maybe; /** The title of the delivery option. */ title?: Maybe; }; /** A delivery method with a pickup option. */ export type SubscriptionDeliveryMethodPickup = { __typename?: 'SubscriptionDeliveryMethodPickup'; /** The details of the pickup delivery method. */ pickupOption: SubscriptionDeliveryMethodPickupOption; }; /** The input fields for a pickup delivery method. */ export type SubscriptionDeliveryMethodPickupInput = { /** The ID of the pickup location. */ locationId: Scalars['ID']['input']; }; /** Represents the selected pickup option on a subscription contract. */ export type SubscriptionDeliveryMethodPickupOption = { __typename?: 'SubscriptionDeliveryMethodPickupOption'; /** The details displayed to the customer to describe the pickup option. */ description?: Maybe; /** The address where the customer will pick up the merchandise. */ pickupAddress: PickupAddress; /** The presentment title of the pickup option. */ presentmentTitle?: Maybe; /** The title of the pickup option. */ title?: Maybe; }; /** The shipping delivery method, including a mailing address and a shipping option. */ export type SubscriptionDeliveryMethodShipping = { __typename?: 'SubscriptionDeliveryMethodShipping'; /** The address for shipping. */ address: SubscriptionMailingAddress; /** The details of the shipping method. */ shippingOption: SubscriptionDeliveryMethodShippingOption; }; /** The input fields for a shipping delivery method. */ export type SubscriptionDeliveryMethodShippingInput = { /** The address to ship to. */ shippingAddress?: InputMaybe; }; /** The selected shipping option on a subscription contract. */ export type SubscriptionDeliveryMethodShippingOption = { __typename?: 'SubscriptionDeliveryMethodShippingOption'; /** 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; }; /** The delivery option for a subscription contract. */ export type SubscriptionDeliveryOption = | SubscriptionLocalDeliveryOption | SubscriptionPickupOption | SubscriptionShippingOption; /** The result of the query that fetches delivery options for the subscription contract. */ export type SubscriptionDeliveryOptionsResult = | SubscriptionDeliveryOptionsResultFailure | SubscriptionDeliveryOptionsResultSuccess; /** A failed result indicating unavailability of delivery options for the subscription contract. */ export type SubscriptionDeliveryOptionsResultFailure = { __typename?: 'SubscriptionDeliveryOptionsResultFailure'; /** The reason for the failure. */ message?: Maybe; }; /** A successful result containing the available delivery options for the subscription contract. */ export type SubscriptionDeliveryOptionsResultSuccess = { __typename?: 'SubscriptionDeliveryOptionsResultSuccess'; /** The available delivery options. */ deliveryOptions: Array; /** The token associated with the successful result of delivery options. */ token: Scalars['String']['output']; }; /** The delivery policy of a subscription. */ export type SubscriptionDeliveryPolicy = { __typename?: 'SubscriptionDeliveryPolicy'; /** The anchor dates for calculating delivery intervals. */ anchors: Array; /** The type of interval associated with this schedule (e.g. Monthly, Weekly, etc). */ interval: SubscriptionInterval; /** The number of intervals between deliveries. */ intervalCount?: Maybe; }; /** A discount applied to a subscription contract. */ export type SubscriptionDiscount = { __typename?: 'SubscriptionDiscount'; /** Specify whether the subscription discount will apply on all subscription lines. */ appliesToAllLines: Scalars['Boolean']['output']; /** The unique ID. */ id: Scalars['ID']['output']; /** The list of subscription lines associated with the subscription discount. */ lines?: Maybe; /** The maximum number of times the subscription discount will be applied on orders. */ recurringCycleLimit?: 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?: Maybe; /** The value of the subscription discount. */ value: SubscriptionDiscountValue; }; /** A discount applied to a subscription contract. */ export type SubscriptionDiscountLinesArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** 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'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in SubscriptionDiscountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination. */ export type SubscriptionDiscountEdge = { __typename?: 'SubscriptionDiscountEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of SubscriptionDiscountEdge. */ node: SubscriptionDiscount; }; /** 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']['output']; }; /** The percentage value of the discount. */ export type SubscriptionDiscountPercentageValue = { __typename?: 'SubscriptionDiscountPercentageValue'; /** The percentage value of the discount. */ percentage: Scalars['Int']['output']; }; /** The value of the discount and how it will be applied. */ export type SubscriptionDiscountValue = | SubscriptionDiscountFixedAmountValue | SubscriptionDiscountPercentageValue; /** Defines valid subscription intervals. */ export type SubscriptionInterval = /** Represents a day interval. */ | 'DAY' /** Represents a month interval. */ | 'MONTH' /** Represents a week interval. */ | 'WEEK' /** Represents a year interval. */ | 'YEAR'; /** A line item in a subscription. */ export type SubscriptionLine = { __typename?: 'SubscriptionLine'; /** The current price per unit for the subscription line in the contract's currency. */ currentPrice: MoneyV2; /** The custom attributes associated with the line item. */ customAttributes: Array; /** Discount allocations. */ discountAllocations: Array; /** The unique ID of the line item. */ id: Scalars['ID']['output']; /** The image associated with the product variant. */ image?: Maybe; /** The total price of the line item after all discounts have been applied. */ lineDiscountedPrice: MoneyV2; /** The name of the product. */ name: Scalars['String']['output']; /** * The URL of the product in the online store. * A value of `null` indicates that the product isn't published in the Online Store sales channel. */ onlineStoreUrl?: Maybe; /** The quantity of the unit selected for the subscription line. */ quantity: Scalars['Int']['output']; /** Whether the product variant requires shipping. */ requiresShipping: Scalars['Boolean']['output']; /** The SKU of the product variant associated with the subscription line. */ sku?: Maybe; /** Whether the product variant is taxable. */ taxable: Scalars['Boolean']['output']; /** The title of the product associated with the subscription line. */ title: Scalars['String']['output']; /** The image associated with the product variant. */ variantImage?: Maybe; /** The title of the product variant associated with the subscription line. */ variantTitle?: Maybe; }; /** An auto-generated type for paginating through multiple SubscriptionLines. */ export type SubscriptionLineConnection = { __typename?: 'SubscriptionLineConnection'; /** The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. */ edges: Array; /** A list of nodes that are contained in SubscriptionLineEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. */ nodes: Array; /** An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. */ pageInfo: PageInfo; }; /** An auto-generated type which holds one SubscriptionLine and a cursor during pagination. */ export type SubscriptionLineEdge = { __typename?: 'SubscriptionLineEdge'; /** The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). */ cursor: Scalars['String']['output']; /** The item at the end of SubscriptionLineEdge. */ node: SubscriptionLine; }; /** A local delivery option for a subscription contract. */ export type SubscriptionLocalDeliveryOption = { __typename?: 'SubscriptionLocalDeliveryOption'; /** The code of the local delivery option. */ code: Scalars['String']['output']; /** The description of the local delivery option. */ description?: Maybe; /** Whether a phone number is required for the local delivery option. */ phoneRequired: Scalars['Boolean']['output']; /** The presentment title of the local delivery option. */ presentmentTitle?: Maybe; /** The price of the local delivery option. */ price: MoneyV2; /** The title of the local delivery option. */ title: Scalars['String']['output']; }; /** The 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 apartment, suite, or unit number. */ 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 the first name and last name. */ name?: Maybe; /** A unique phone number for the customer, formatted using the E.164 standard. For example, _+16135551111_. */ phone?: Maybe; /** The region of the address, such as the province, state, or district. */ province?: Maybe; /** * The alphanumeric code for the region. * For example, ON. */ provinceCode?: Maybe; /** The zip or postal code of the address. */ zip?: Maybe; }; /** Represents an anchor specifying a day of the month. */ export type SubscriptionMonthDayAnchor = { __typename?: 'SubscriptionMonthDayAnchor'; /** Day of the month (1-31). */ dayOfMonth: Scalars['Int']['output']; }; /** A pickup option to deliver a subscription contract. */ export type SubscriptionPickupOption = { __typename?: 'SubscriptionPickupOption'; /** The code of the pickup option. */ code: Scalars['String']['output']; /** The description of the pickup option. */ description?: Maybe; /** The ID of the pickup location. */ locationId: Scalars['ID']['output']; /** Whether a phone number is required for the pickup option. */ phoneRequired: Scalars['Boolean']['output']; /** The address where the customer will pick up the merchandise. */ pickupAddress: PickupAddress; /** The estimated amount of time it takes for the pickup to be ready. For example, "Usually ready in 24 hours". */ pickupTime: Scalars['String']['output']; /** The presentment title of the pickup option. */ presentmentTitle?: Maybe; /** The price of the pickup option. */ price: MoneyV2; /** The title of the pickup option. */ title: Scalars['String']['output']; }; /** Represents the breakdown of prices to be charges in the billing attempt. */ export type SubscriptionPriceBreakdown = { __typename?: 'SubscriptionPriceBreakdown'; /** * The sum of the prices for all line items after discounts. * If taxesIncluded is true, then the subtotal also includes tax. */ subtotalPrice: MoneyV2; /** Whether taxes are included in the subtotal price. */ taxesIncluded: Scalars['Boolean']['output']; /** * The total amount discounted. * This includes both order and line level discounts. */ totalDiscounts: MoneyV2; /** The total price. This includes taxes and discounts. */ totalPrice: MoneyV2; /** The total shipping amount before discounts and returns. */ totalShippingPrice: MoneyV2; /** The total tax amount. */ totalTax: MoneyV2; }; /** A shipping option to deliver a subscription contract. */ export type SubscriptionShippingOption = { __typename?: 'SubscriptionShippingOption'; /** The code of the shipping option. */ code: Scalars['String']['output']; /** The description of the shipping option. */ description?: Maybe; /** Whether a phone number is required for the shipping option. */ phoneRequired: Scalars['Boolean']['output']; /** The presentment title of the shipping option. */ presentmentTitle?: Maybe; /** The price of the shipping option. */ price: MoneyV2; /** The title of the shipping option. */ title: Scalars['String']['output']; }; /** Represents an anchor specifying a day of the week. */ export type SubscriptionWeekDayAnchor = { __typename?: 'SubscriptionWeekDayAnchor'; /** Day of the week (1-7, where 1 is Monday). */ dayOfWeek: Scalars['Int']['output']; }; /** Represents an anchor specifying a specific day and month of the year. */ export type SubscriptionYearDayAnchor = { __typename?: 'SubscriptionYearDayAnchor'; /** Day of the month (1-31). Specifies the exact day within the given month. */ dayOfMonth: Scalars['Int']['output']; /** Month of the year (1-12). Specifies the month in which the day occurs. */ month: Scalars['Int']['output']; }; /** The available tax exemptions for a customer. */ export type TaxExemption = /** This customer is exempt from GST taxes for holding a valid exemption. The business customer should provide their GST number and account for the GST. */ | 'AUSTRALIA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia. */ | 'CA_BC_COMMERCIAL_FISHERY_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia. */ | 'CA_BC_CONTRACTOR_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia. */ | 'CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia. */ | 'CA_BC_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia. */ | 'CA_BC_SUB_CONTRACTOR_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada. */ | 'CA_DIPLOMAT_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba. */ | 'CA_MB_COMMERCIAL_FISHERY_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba. */ | 'CA_MB_FARMER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba. */ | 'CA_MB_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia. */ | 'CA_NS_COMMERCIAL_FISHERY_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia. */ | 'CA_NS_FARMER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario. */ | 'CA_ON_PURCHASE_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island. */ | 'CA_PE_COMMERCIAL_FISHERY_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan. */ | 'CA_SK_COMMERCIAL_FISHERY_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan. */ | 'CA_SK_CONTRACTOR_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan. */ | 'CA_SK_FARMER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan. */ | 'CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan. */ | 'CA_SK_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan. */ | 'CA_SK_SUB_CONTRACTOR_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada. */ | 'CA_STATUS_CARD_EXEMPTION' /** This customer is exempt from VAT for purchases within the EU that is shipping from outside of customer's country, as well as purchases from the EU to the UK. */ | 'EU_REVERSE_CHARGE_EXEMPTION_RULE' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alaska. */ | 'US_AK_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alabama. */ | 'US_AL_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arkansas. */ | 'US_AR_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arizona. */ | 'US_AZ_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in California. */ | 'US_CA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Colorado. */ | 'US_CO_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Connecticut. */ | 'US_CT_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington DC. */ | 'US_DC_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Delaware. */ | 'US_DE_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Florida. */ | 'US_FL_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Georgia. */ | 'US_GA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Hawaii. */ | 'US_HI_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Iowa. */ | 'US_IA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Idaho. */ | 'US_ID_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Illinois. */ | 'US_IL_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Indiana. */ | 'US_IN_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kansas. */ | 'US_KS_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kentucky. */ | 'US_KY_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Louisiana. */ | 'US_LA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Massachusetts. */ | 'US_MA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maryland. */ | 'US_MD_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maine. */ | 'US_ME_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Michigan. */ | 'US_MI_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Minnesota. */ | 'US_MN_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Missouri. */ | 'US_MO_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Mississippi. */ | 'US_MS_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Montana. */ | 'US_MT_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Carolina. */ | 'US_NC_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Dakota. */ | 'US_ND_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nebraska. */ | 'US_NE_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Hampshire. */ | 'US_NH_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Jersey. */ | 'US_NJ_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Mexico. */ | 'US_NM_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nevada. */ | 'US_NV_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New York. */ | 'US_NY_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Ohio. */ | 'US_OH_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oklahoma. */ | 'US_OK_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oregon. */ | 'US_OR_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Pennsylvania. */ | 'US_PA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Rhode Island. */ | 'US_RI_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Carolina. */ | 'US_SC_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Dakota. */ | 'US_SD_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Tennessee. */ | 'US_TN_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Texas. */ | 'US_TX_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Utah. */ | 'US_UT_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Virginia. */ | 'US_VA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Vermont. */ | 'US_VT_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington. */ | 'US_WA_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wisconsin. */ | 'US_WI_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in West Virginia. */ | 'US_WV_RESELLER_EXEMPTION' /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wyoming. */ | 'US_WY_RESELLER_EXEMPTION'; /** The detailed information about tax exemptions that can be applied to customers. */ export type TaxExemptionDetails = { __typename?: 'TaxExemptionDetails'; /** Whether the tax exemption can be applied on tax lines. */ applicable: Scalars['Boolean']['output']; /** An identifier that groups exemptions. */ exemptionGroup: Scalars['String']['output']; /** The translated display name of the tax exemption group. */ exemptionGroupName: Scalars['String']['output']; /** The translated display name of the tax exemption when grouped. */ groupedName: Scalars['String']['output']; /** The translated display name of the tax exemption. */ name: Scalars['String']['output']; /** The code of the tax region this exemption applies to. If null, it applies in all regions. */ taxRegionCode?: Maybe; /** The unique type of the exemption. */ type: TaxExemption; }; /** A tax invoice on an order. */ export type TaxInvoice = { __typename?: 'TaxInvoice'; /** The time zone of the destination address of the tax invoice. */ buyerTimeZone: Scalars['String']['output']; /** The datetime of when the tax invoice was created. */ createdAt: Scalars['DateTime']['output']; /** The invoice number of the tax invoice. */ invoiceNumber: Scalars['String']['output']; /** The current processing status of the tax invoice. */ status: TaxInvoiceStatus; /** The url to download the tax invoice. */ url: Scalars['URL']['output']; }; /** The current processing status of the tax invoices. */ export type TaxInvoiceStatus = /** The tax invoice has been created. */ | 'PROCESSED' /** The tax invoice is being created. */ | 'PROCESSING'; /** The details about a single tax applied to the associated line item. */ export type TaxLine = Node & { __typename?: 'TaxLine'; /** Whether the channel that submitted the tax line is responsible for remitting it. */ channelLiable: Scalars['Boolean']['output']; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The tax amount in shop and presentment currencies, calculated after discounts and before returns. */ priceSet: MoneyV2; /** The proportion of the line item price represented by the tax, expressed as a decimal. */ rate?: Maybe; /** The proportion of the line item price represented by the tax, expressed as a percentage. */ ratePercentage?: Maybe; /** The origin of the tax. */ source?: Maybe; /** The name of the applied tax. */ title: Scalars['String']['output']; }; /** The ISO 3166-1 alpha-2 codes that distinguish a region where common tax rules apply. */ export type TaxRegionCode = /** Ascension Island. */ | 'AC' /** Andorra. */ | 'AD' /** United Arab Emirates. */ | 'AE' /** Afghanistan. */ | 'AF' /** Antigua & Barbuda. */ | 'AG' /** Anguilla. */ | 'AI' /** Albania. */ | 'AL' /** Armenia. */ | 'AM' /** Netherlands Antilles. */ | 'AN' /** Angola. */ | 'AO' /** Argentina. */ | 'AR' /** Austria. */ | 'AT' /** Australia. */ | 'AU' /** Aruba. */ | 'AW' /** Åland Islands. */ | 'AX' /** Azerbaijan. */ | 'AZ' /** Bosnia & Herzegovina. */ | 'BA' /** Barbados. */ | 'BB' /** Bangladesh. */ | 'BD' /** Belgium. */ | 'BE' /** Burkina Faso. */ | 'BF' /** Bulgaria. */ | 'BG' /** Bahrain. */ | 'BH' /** Burundi. */ | 'BI' /** Benin. */ | 'BJ' /** St. Barthélemy. */ | 'BL' /** Bermuda. */ | 'BM' /** Brunei. */ | 'BN' /** Bolivia. */ | 'BO' /** Caribbean Netherlands. */ | 'BQ' /** Brazil. */ | 'BR' /** Bahamas. */ | 'BS' /** Bhutan. */ | 'BT' /** Bouvet Island. */ | 'BV' /** Botswana. */ | 'BW' /** Belarus. */ | 'BY' /** Belize. */ | 'BZ' /** Canada. */ | 'CA' /** Cocos (Keeling) Islands. */ | 'CC' /** Congo - Kinshasa. */ | 'CD' /** Central African Republic. */ | 'CF' /** Congo - Brazzaville. */ | 'CG' /** Switzerland. */ | 'CH' /** Côte d’Ivoire. */ | 'CI' /** Cook Islands. */ | 'CK' /** Chile. */ | 'CL' /** Cameroon. */ | 'CM' /** China. */ | 'CN' /** Colombia. */ | 'CO' /** Costa Rica. */ | 'CR' /** Cuba. */ | 'CU' /** Cape Verde. */ | 'CV' /** Curaçao. */ | 'CW' /** Christmas Island. */ | 'CX' /** Cyprus. */ | 'CY' /** Czechia. */ | 'CZ' /** Germany. */ | 'DE' /** Djibouti. */ | 'DJ' /** Denmark. */ | 'DK' /** Dominica. */ | 'DM' /** Dominican Republic. */ | 'DO' /** Algeria. */ | 'DZ' /** Ecuador. */ | 'EC' /** Estonia. */ | 'EE' /** Egypt. */ | 'EG' /** Western Sahara. */ | 'EH' /** Eritrea. */ | 'ER' /** Spain. */ | 'ES' /** Ethiopia. */ | 'ET' /** European Union. */ | 'EU' /** Finland. */ | 'FI' /** Fiji. */ | 'FJ' /** Falkland Islands. */ | 'FK' /** Faroe Islands. */ | 'FO' /** France. */ | 'FR' /** Gabon. */ | 'GA' /** United Kingdom. */ | 'GB' /** Grenada. */ | 'GD' /** Georgia. */ | 'GE' /** French Guiana. */ | 'GF' /** Guernsey. */ | 'GG' /** Ghana. */ | 'GH' /** Gibraltar. */ | 'GI' /** Greenland. */ | 'GL' /** Gambia. */ | 'GM' /** Guinea. */ | 'GN' /** Guadeloupe. */ | 'GP' /** Equatorial Guinea. */ | 'GQ' /** Greece. */ | 'GR' /** South Georgia & South Sandwich Islands. */ | 'GS' /** Guatemala. */ | 'GT' /** Guinea-Bissau. */ | 'GW' /** Guyana. */ | 'GY' /** Hong Kong SAR. */ | 'HK' /** Heard & McDonald Islands. */ | 'HM' /** Honduras. */ | 'HN' /** Croatia. */ | 'HR' /** Haiti. */ | 'HT' /** Hungary. */ | 'HU' /** Indonesia. */ | 'ID' /** Ireland. */ | 'IE' /** Israel. */ | 'IL' /** Isle of Man. */ | 'IM' /** India. */ | 'IN' /** British Indian Ocean Territory. */ | 'IO' /** Iraq. */ | 'IQ' /** Iran. */ | 'IR' /** Iceland. */ | 'IS' /** Italy. */ | 'IT' /** Jersey. */ | 'JE' /** Jamaica. */ | 'JM' /** Jordan. */ | 'JO' /** Japan. */ | 'JP' /** Kenya. */ | 'KE' /** Kyrgyzstan. */ | 'KG' /** Cambodia. */ | 'KH' /** Kiribati. */ | 'KI' /** Comoros. */ | 'KM' /** St. Kitts & Nevis. */ | 'KN' /** North Korea. */ | 'KP' /** South Korea. */ | 'KR' /** Kuwait. */ | 'KW' /** Cayman Islands. */ | 'KY' /** Kazakhstan. */ | 'KZ' /** Laos. */ | 'LA' /** Lebanon. */ | 'LB' /** St. Lucia. */ | 'LC' /** Liechtenstein. */ | 'LI' /** Sri Lanka. */ | 'LK' /** Liberia. */ | 'LR' /** Lesotho. */ | 'LS' /** Lithuania. */ | 'LT' /** Luxembourg. */ | 'LU' /** Latvia. */ | 'LV' /** Libya. */ | 'LY' /** Morocco. */ | 'MA' /** Monaco. */ | 'MC' /** Moldova. */ | 'MD' /** Montenegro. */ | 'ME' /** St. Martin. */ | 'MF' /** Madagascar. */ | 'MG' /** North Macedonia. */ | 'MK' /** Mali. */ | 'ML' /** Myanmar (Burma). */ | 'MM' /** Mongolia. */ | 'MN' /** Macao SAR. */ | 'MO' /** Martinique. */ | 'MQ' /** Mauritania. */ | 'MR' /** Montserrat. */ | 'MS' /** Malta. */ | 'MT' /** Mauritius. */ | 'MU' /** Maldives. */ | 'MV' /** Malawi. */ | 'MW' /** Mexico. */ | 'MX' /** Malaysia. */ | 'MY' /** Mozambique. */ | 'MZ' /** Namibia. */ | 'NA' /** New Caledonia. */ | 'NC' /** Niger. */ | 'NE' /** Norfolk Island. */ | 'NF' /** Nigeria. */ | 'NG' /** Nicaragua. */ | 'NI' /** Netherlands. */ | 'NL' /** Norway. */ | 'NO' /** Nepal. */ | 'NP' /** Nauru. */ | 'NR' /** Niue. */ | 'NU' /** New Zealand. */ | 'NZ' /** Oman. */ | 'OM' /** Panama. */ | 'PA' /** Peru. */ | 'PE' /** French Polynesia. */ | 'PF' /** Papua New Guinea. */ | 'PG' /** Philippines. */ | 'PH' /** Pakistan. */ | 'PK' /** Poland. */ | 'PL' /** St. Pierre & Miquelon. */ | 'PM' /** Pitcairn Islands. */ | 'PN' /** Palestinian Territories. */ | 'PS' /** Portugal. */ | 'PT' /** Paraguay. */ | 'PY' /** Qatar. */ | 'QA' /** Réunion. */ | 'RE' /** Romania. */ | 'RO' /** Serbia. */ | 'RS' /** Russia. */ | 'RU' /** Rwanda. */ | 'RW' /** Saudi Arabia. */ | 'SA' /** Solomon Islands. */ | 'SB' /** Seychelles. */ | 'SC' /** Sudan. */ | 'SD' /** Sweden. */ | 'SE' /** Singapore. */ | 'SG' /** St. Helena. */ | 'SH' /** Slovenia. */ | 'SI' /** Svalbard & Jan Mayen. */ | 'SJ' /** Slovakia. */ | 'SK' /** Sierra Leone. */ | 'SL' /** San Marino. */ | 'SM' /** Senegal. */ | 'SN' /** Somalia. */ | 'SO' /** Suriname. */ | 'SR' /** South Sudan. */ | 'SS' /** São Tomé & Príncipe. */ | 'ST' /** El Salvador. */ | 'SV' /** Sint Maarten. */ | 'SX' /** Syria. */ | 'SY' /** Eswatini. */ | 'SZ' /** Tristan da Cunha. */ | 'TA' /** Turks & Caicos Islands. */ | 'TC' /** Chad. */ | 'TD' /** French Southern Territories. */ | 'TF' /** Togo. */ | 'TG' /** Thailand. */ | 'TH' /** Tajikistan. */ | 'TJ' /** Tokelau. */ | 'TK' /** Timor-Leste. */ | 'TL' /** Turkmenistan. */ | 'TM' /** Tunisia. */ | 'TN' /** Tonga. */ | 'TO' /** Türkiye. */ | 'TR' /** Trinidad & Tobago. */ | 'TT' /** Tuvalu. */ | 'TV' /** Taiwan. */ | 'TW' /** Tanzania. */ | 'TZ' /** Ukraine. */ | 'UA' /** Uganda. */ | 'UG' /** U.S. Outlying Islands. */ | 'UM' /** United States. */ | 'US' /** Uruguay. */ | 'UY' /** Uzbekistan. */ | 'UZ' /** Vatican City. */ | 'VA' /** St. Vincent & Grenadines. */ | 'VC' /** Venezuela. */ | 'VE' /** British Virgin Islands. */ | 'VG' /** Vietnam. */ | 'VN' /** Vanuatu. */ | 'VU' /** Wallis & Futuna. */ | 'WF' /** Samoa. */ | 'WS' /** Kosovo. */ | 'XK' /** Yemen. */ | 'YE' /** Mayotte. */ | 'YT' /** South Africa. */ | 'ZA' /** Zambia. */ | 'ZM' /** Zimbabwe. */ | 'ZW'; /** The events that chronicle resource activities available to the customer. */ export type TimelineEvent = Node & { __typename?: 'TimelineEvent'; /** The date and time when the event occurred. */ happenedAt: Scalars['DateTime']['output']; /** The unique ID for the timeline event. */ id: Scalars['ID']['output']; /** Additional details about the event. */ message?: Maybe; /** The subtitle of the event. */ subtitle?: Maybe; /** The title of the event. */ title: Scalars['String']['output']; }; /** A sale that is associated with a tip. */ export type TipSale = Node & Sale & { __typename?: 'TipSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The line item associated with the sale. */ lineItem: LineItem; /** The type of line associated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** Represents the tracking information for a fulfillment. */ export type TrackingInformation = { __typename?: 'TrackingInformation'; /** The name of the tracking company. */ company?: Maybe; /** The tracking number for the fulfillment. */ number?: Maybe; /** The URLs to track the fulfillment. */ url?: Maybe; }; /** The set of valid sort keys for the Transaction query. */ export type TransactionSortKeys = /** Sort by the `created_at` value. */ | 'CREATED_AT' /** Sort by the `expires_at` value. */ | 'EXPIRES_AT'; /** The details related to the transaction type. */ export type TransactionTypeDetails = { __typename?: 'TransactionTypeDetails'; /** The message of the transaction type. */ message?: Maybe; /** The name of the transaction type. */ name?: Maybe; }; /** * The custom data attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. */ export type UiExtensionMetafield = Node & { __typename?: 'UiExtensionMetafield'; /** The description of a metafield. */ description?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The key name for a metafield. */ key: Scalars['String']['output']; /** The namespace for a metafield. */ namespace: Scalars['String']['output']; /** The owner ID for a metafield. */ ownerId: Scalars['ID']['output']; /** * The type name of the metafield. * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). */ type: Scalars['String']['output']; /** The value of a metafield. */ value: Scalars['String']['output']; /** * Represents the metafield value type. * @deprecated `valueType` is deprecated and replaced by `type`. */ valueType: MetafieldValueType; }; /** A session token for a UI extension. */ export type UiExtensionSessionToken = { __typename?: 'UiExtensionSessionToken'; /** The second count until the session token expires. */ expiresIn: Scalars['Int']['output']; /** The value of the UI extension session token. */ value: Scalars['String']['output']; }; /** The information about the container for unfulfilled digital line items (excluding gift cards). */ export type UnfulfilledDigitalLineItemContainer = UnfulfilledLineItemContainerCommonFields & { __typename?: 'UnfulfilledDigitalLineItemContainer'; /** The line items within this container. */ lineItems: LineItemContainerLineItemConnection; }; /** The information about the container for unfulfilled digital line items (excluding gift cards). */ export type UnfulfilledDigitalLineItemContainerLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The information about the container for unfulfilled gift card type line items. */ export type UnfulfilledGiftCardLineItemContainer = UnfulfilledLineItemContainerCommonFields & { __typename?: 'UnfulfilledGiftCardLineItemContainer'; /** The line items within this container. */ lineItems: LineItemContainerLineItemConnection; }; /** The information about the container for unfulfilled gift card type line items. */ export type UnfulfilledGiftCardLineItemContainerLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The information about the container for unfulfilled line items. */ export type UnfulfilledLineItemContainer = UnfulfilledLineItemContainerCommonFields & { __typename?: 'UnfulfilledLineItemContainer'; /** The translated state of the line item container (for example, `Unfulfilled`). */ displayableState: Scalars['String']['output']; /** The line items within this container. */ lineItems: LineItemContainerLineItemConnection; /** The state of the line item container (for example, `unfulfilled`). */ state: Scalars['String']['output']; }; /** The information about the container for unfulfilled line items. */ export type UnfulfilledLineItemContainerLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The common fields for containers of unfulfilled line items series. */ export type UnfulfilledLineItemContainerCommonFields = { /** The line items within this container. */ lineItems: LineItemContainerLineItemConnection; }; /** The common fields for containers of unfulfilled line items series. */ export type UnfulfilledLineItemContainerCommonFieldsLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The information about the container for unfulfilled physical type line items. */ export type UnfulfilledPhysicalLineItemContainer = UnfulfilledLineItemContainerCommonFields & { __typename?: 'UnfulfilledPhysicalLineItemContainer'; /** The line items within this container. */ lineItems: LineItemContainerLineItemConnection; }; /** The information about the container for unfulfilled physical type line items. */ export type UnfulfilledPhysicalLineItemContainerLineItemsArgs = { after?: InputMaybe; before?: InputMaybe; first?: InputMaybe; last?: InputMaybe; reverse?: InputMaybe; }; /** The unit price of the line component. For example, "$9.99 / 100ml". */ export type UnitPrice = { __typename?: 'UnitPrice'; /** The unit measurement. For example, "$9.99 / 100ml". */ measurement: UnitPriceMeasurement; /** The unit price of the variant. For example, "$1 per xy" where price is "$1". */ price: MoneyV2; }; /** The unit price measurement of the line component. For example, "$9.99 / 100ml". */ export type UnitPriceMeasurement = { __typename?: 'UnitPriceMeasurement'; /** The reference unit for the unit price measurement. For example, "$9.99 / 100ml" where the reference unit is "ml". */ referenceUnit: UnitPriceMeasurementUnit; /** The reference value for the unit price measurement. For example, "$9.99 / 100ml" where the reference value is "100". */ referenceValue: Scalars['Int']['output']; }; /** The valid units of measurement for a unit price measurement. */ export type UnitPriceMeasurementUnit = /** 100 centiliters equals 1 liter. */ | 'CL' /** 100 centimeters equals 1 meter. */ | 'CM' /** Imperial system unit of volume (U.S. customary unit). */ | 'FLOZ' /** 1 foot equals 12 inches. */ | 'FT' /** Imperial system unit of area. */ | 'FT2' /** Metric system unit of weight. */ | 'G' /** 1 gallon equals 128 fluid ounces (U.S. customary unit). */ | 'GAL' /** Imperial system unit of length. */ | 'IN' /** 1 item, a unit of count. */ | 'ITEM' /** 1 kilogram equals 1000 grams. */ | 'KG' /** Metric system unit of volume. */ | 'L' /** Imperial system unit of weight. */ | 'LB' /** Metric system unit of length. */ | 'M' /** Metric system unit of area. */ | 'M2' /** 1 cubic meter equals 1000 liters. */ | 'M3' /** 1000 milligrams equals 1 gram. */ | 'MG' /** 1000 milliliters equals 1 liter. */ | 'ML' /** 1000 millimeters equals 1 meter. */ | 'MM' /** 16 ounces equals 1 pound. */ | 'OZ' /** 1 pint equals 16 fluid ounces (U.S. customary unit). */ | 'PT' /** 1 quart equals 32 fluid ounces (U.S. customary unit). */ | 'QT' /** The unit of measurement is unknown. Upgrade to the latest version of the API to resolve this unit. */ | 'UNKNOWN' /** 1 yard equals 36 inches. */ | 'YD'; /** This represents new sale types that have been added in future API versions. You may update to a more recent API version to receive additional details about this sale. */ export type UnknownSale = Node & Sale & { __typename?: 'UnknownSale'; /** The type of order action represented by the sale. */ actionType: SaleActionType; /** The unique ID of the sale. */ id: Scalars['ID']['output']; /** The line type assocated with the sale. */ lineType: SaleLineType; /** The number of units ordered or intended to be returned. */ quantity?: Maybe; /** The individual taxes associated with the sale. */ taxes: Array; /** The total sale amount after taxes and discounts. */ totalAmount: MoneyV2; /** The total amount of discounts allocated to the sale after taxes. */ totalDiscountAmountAfterTaxes: MoneyV2; /** The total discounts allocated to the sale before taxes. */ totalDiscountAmountBeforeTaxes: MoneyV2; /** The total tax amount for the sale. */ totalTaxAmount: MoneyV2; }; /** An unverified return line item. */ export type UnverifiedReturnLineItem = Node & ReturnLineItemType & { __typename?: 'UnverifiedReturnLineItem'; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The specific line item that's being returned. */ lineItem: LineItem; /** The quantity of the line item that's been returned. */ quantity: Scalars['Int']['output']; /** * The reason for returning the line item. * @deprecated Use `returnReasonDefinition` instead. This field will be removed in the future. */ returnReason: ReturnReason; /** The standardized reason for why the item is being returned. */ returnReasonDefinition?: Maybe; }; /** The error codes for failed business contact mutations. */ export type UserErrorsBusinessContactUserErrors = DisplayableError & { __typename?: 'UserErrorsBusinessContactUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsBusinessContactUserErrors`. */ export type UserErrorsBusinessContactUserErrorsCode = /** Business contact was not found. */ | 'BUSINESS_CONTACT_NOT_FOUND' /** Business contact update input argument is empty. */ | 'BUSINESS_CONTACT_UPDATE_INPUT_ARGUMENT_EMPTY' /** Business contact field is too long. */ | 'TOO_LONG'; /** The error codes for failed payment instrument mutations. */ export type UserErrorsBusinessLocationPaymentInstrumentUserErrors = DisplayableError & { __typename?: 'UserErrorsBusinessLocationPaymentInstrumentUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsBusinessLocationPaymentInstrumentUserErrors`. */ export type UserErrorsBusinessLocationPaymentInstrumentUserErrorsCode = /** Address1 field is missing. */ | 'ADDRESS1_MISSING' /** Address argument is empty. */ | 'ADDRESS_ARGUMENT_EMPTY' /** The card's brand is not supported. */ | 'BRAND_NOT_SUPPORTED' /** Cannot replace a payment instrument with itself. */ | 'CANNOT_REPLACE_PAYMENT_INSTRUMENT_WITH_ITSELF' /** City field is missing. */ | 'CITY_MISSING' /** Company location ID does not exist. */ | 'COMPANY_LOCATION_ID_DOES_NOT_EXIST' /** Country Code field is missing. */ | 'COUNTRY_CODE_MISSING' /** The card was declined. */ | 'DECLINED' /** The card is expired. */ | 'EXPIRED' /** The card's first name is missing. */ | 'FIRST_NAME_BLANK' /** An error occured. */ | 'GENERIC_ERROR' /** The address is incorrect. */ | 'INCORRECT' /** Address field is not valid. */ | 'INVALID' /** Invalid for country. */ | 'INVALID_FOR_COUNTRY' /** Invalid for country and province. */ | 'INVALID_FOR_COUNTRY_AND_PROVINCE' /** Invalid province in country. */ | 'INVALID_PROVINCE_IN_COUNTRY' /** The card's start date or issue number is invalid. */ | 'INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT' /** Invalid state in country. */ | 'INVALID_STATE_IN_COUNTRY' /** The card's last name is missing. */ | 'LAST_NAME_BLANK' /** The card's month is invalid. */ | 'MONTH_INVALID' /** The card's name is invalid. */ | 'NAME_INVALID' /** The card's number is invalid. */ | 'NUMBER_INVALID' /** Payment instrument ID does not exist. */ | 'PAYMENT_INSTRUMENT_ID_DOES_NOT_EXIST' /** This payment instrument is already on file. */ | 'PAYMENT_INSTRUMENT_TAKEN' /** Phone number is not valid. */ | 'PHONE_NUMBER_NOT_VALID' /** The field is required. */ | 'REQUIRED' /** This test card cannot be used for real transactions. */ | 'TEST_MODE_LIVE_CARD' /** Address field is too long. */ | 'TOO_LONG' /** Too many payment instrument updates. */ | 'UPDATE_LIMIT_EXCEEDED' /** The card's verification value is missing. */ | 'VERIFICATION_VALUE_BLANK' /** The card's verification value is incorrect. */ | 'VERIFICATION_VALUE_INCORRECT' /** The card's verification value is invalid. */ | 'VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE' /** The card's year is invalid. */ | 'YEAR_INVALID' /** The address's zip code is incorrect. */ | 'ZIP_INCORRECT' /** Zone Code field is missing. */ | 'ZONE_CODE_MISSING'; /** The error codes that are provided for failed address mutations. */ export type UserErrorsCustomerAddressUserErrors = DisplayableError & { __typename?: 'UserErrorsCustomerAddressUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsCustomerAddressUserErrors`. */ export type UserErrorsCustomerAddressUserErrorsCode = /** The Address1 field is missing. */ | 'ADDRESS1_MISSING' /** The provided address argument is empty. */ | 'ADDRESS_ARGUMENT_EMPTY' /** The provided address ID doesn't exist. */ | 'ADDRESS_ID_DOES_NOT_EXIST' /** Input contains HTML tags. */ | 'CONTAINS_HTML_TAGS' /** The provided country doesn't exist. */ | 'COUNTRY_NOT_EXIST' /** The provided customer address already exists. */ | 'CUSTOMER_ADDRESS_ALREADY_EXISTS' /** The default address of the customer can't be deleted before setting another one as default. */ | 'DELETING_CUSTOMER_DEFAULT_ADDRESS_NOT_ALLOWED' /** Demoting the default address of the customer isn't allowed. */ | 'DEMOTING_CUSTOMER_DEFAULT_ADDRESS_NOT_ALLOWED' /** The provided address field isn't valid. */ | 'INVALID' /** The provided value is invalid for the country. */ | 'INVALID_FOR_COUNTRY' /** The provided value is invalid for the country and province. */ | 'INVALID_FOR_COUNTRY_AND_PROVINCE' /** The provided Territory Code isn't valid. */ | 'INVALID_TERRITORY_CODE' /** The provided phone number isn't valid. */ | 'PHONE_NUMBER_NOT_VALID' /** The field is required. */ | 'REQUIRED' /** The Territory Code field is missing. */ | 'TERRITORY_CODE_MISSING' /** The provided address field is too long. */ | 'TOO_LONG' /** The Zone Code field is missing. */ | 'ZONE_CODE_MISSING'; /** Provides error codes for failed marketing opt-in mutations. */ export type UserErrorsCustomerEmailMarketingOptInUserErrors = DisplayableError & { __typename?: 'UserErrorsCustomerEmailMarketingOptInUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsCustomerEmailMarketingOptInUserErrors`. */ export type UserErrorsCustomerEmailMarketingOptInUserErrorsCode = /** The customer is already subscribed. */ | 'CUSTOMER_ALREADY_SUBSCRIBED' /** The customer does not have an email address. */ | 'EMAIL_ADDRESS_NOT_FOUND' /** There was an error. */ | 'FAILED'; /** Provides error codes for marketing subscribe mutations. */ export type UserErrorsCustomerEmailMarketingUserErrors = DisplayableError & { __typename?: 'UserErrorsCustomerEmailMarketingUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsCustomerEmailMarketingUserErrors`. */ export type UserErrorsCustomerEmailMarketingUserErrorsCode = /** The customer is already subscribed. */ | 'CUSTOMER_ALREADY_SUBSCRIBED' /** The customer does not have an email address. */ | 'EMAIL_ADDRESS_NOT_FOUND' /** Subscription failed. */ | 'FAILED_TO_SUBSCRIBE' /** Unsubscription failed. */ | 'FAILED_TO_UNSUBSCRIBE'; /** Provides error codes for failed personal information mutations. */ export type UserErrorsCustomerUserErrors = DisplayableError & { __typename?: 'UserErrorsCustomerUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsCustomerUserErrors`. */ export type UserErrorsCustomerUserErrorsCode = /** Input contains HTML tags. */ | 'CONTAINS_HTML_TAGS' /** Input contains URL. */ | 'CONTAINS_URL' /** The customer does not exist. */ | 'CUSTOMER_DOES_NOT_EXIST' /** The personal information input argument is empty. */ | 'CUSTOMER_INPUT_ARGUMENT_EMPTY' /** The personal information field is not valid. */ | 'INVALID' /** The personal information field is too long. */ | 'TOO_LONG'; /** The error codes for failed payment instrument mutations. */ export type UserErrorsPaymentInstrumentUserErrors = DisplayableError & { __typename?: 'UserErrorsPaymentInstrumentUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsPaymentInstrumentUserErrors`. */ export type UserErrorsPaymentInstrumentUserErrorsCode = /** Address1 field is missing. */ | 'ADDRESS1_MISSING' /** Address argument is empty. */ | 'ADDRESS_ARGUMENT_EMPTY' /** The card's brand is not supported. */ | 'BRAND_NOT_SUPPORTED' /** Cannot find Shop Pay order for redirection. */ | 'CANNOT_REDIRECT_TO_SHOP_PAY' /** Cannot replace a payment instrument with itself. */ | 'CANNOT_REPLACE_PAYMENT_INSTRUMENT_WITH_ITSELF' /** City field is missing. */ | 'CITY_MISSING' /** Country Code field is missing. */ | 'COUNTRY_CODE_MISSING' /** The card was declined. */ | 'DECLINED' /** The card is expired. */ | 'EXPIRED' /** The card's first name is missing. */ | 'FIRST_NAME_BLANK' /** An error occured. */ | 'GENERIC_ERROR' /** The address is incorrect. */ | 'INCORRECT' /** Address field is not valid. */ | 'INVALID' /** Invalid for country. */ | 'INVALID_FOR_COUNTRY' /** Invalid for country and province. */ | 'INVALID_FOR_COUNTRY_AND_PROVINCE' /** Invalid province in country. */ | 'INVALID_PROVINCE_IN_COUNTRY' /** The card's start date or issue number is invalid. */ | 'INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT' /** Invalid state in country. */ | 'INVALID_STATE_IN_COUNTRY' /** The card's last name is missing. */ | 'LAST_NAME_BLANK' /** The card's month is invalid. */ | 'MONTH_INVALID' /** The card's name is invalid. */ | 'NAME_INVALID' /** The card's number is invalid. */ | 'NUMBER_INVALID' /** Owner ID is invalid. */ | 'OWNER_ID_INVALID' /** Payment instrument ID does not exist. */ | 'PAYMENT_INSTRUMENT_ID_DOES_NOT_EXIST' /** This payment instrument is already on file. */ | 'PAYMENT_INSTRUMENT_TAKEN' /** Phone number is not valid. */ | 'PHONE_NUMBER_NOT_VALID' /** The field is required. */ | 'REQUIRED' /** Saved payment methods is not enabled on this shop. */ | 'SAVED_PAYMENT_METHODS_NOT_ENABLED' /** This test card cannot be used for real transactions. */ | 'TEST_MODE_LIVE_CARD' /** Address field is too long. */ | 'TOO_LONG' /** Payment instrument type is not supported for this operation. */ | 'UNSUPPORTED_PAYMENT_INSTRUMENT_TYPE' /** Too many payment instrument updates. */ | 'UPDATE_LIMIT_EXCEEDED' /** The card's verification value is missing. */ | 'VERIFICATION_VALUE_BLANK' /** The card's verification value is incorrect. */ | 'VERIFICATION_VALUE_INCORRECT' /** The card's verification value is invalid. */ | 'VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE' /** The card's year is invalid. */ | 'YEAR_INVALID' /** The address's zip code is incorrect. */ | 'ZIP_INCORRECT' /** Zone Code field is missing. */ | 'ZONE_CODE_MISSING'; /** The error codes for failed PayPal token mutations. */ export type UserErrorsPaypalTokenUserErrors = DisplayableError & { __typename?: 'UserErrorsPaypalTokenUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsPaypalTokenUserErrors`. */ export type UserErrorsPaypalTokenUserErrorsCode = /** PayPal Express gateway is not enabled. */ | 'PAYPAL_EXPRESS_GATEWAY_NOT_ENABLED' /** PayPal account does not support reference transactions. */ | 'REFERENCE_TRANSACTIONS_NOT_ENABLED' /** PayPal Express token could not be created. */ | 'TOKEN_COULD_NOT_BE_CREATED'; /** The error codes for failed resending gift card mutations. */ export type UserErrorsResendGiftCardErrors = DisplayableError & { __typename?: 'UserErrorsResendGiftCardErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsResendGiftCardErrors`. */ export type UserErrorsResendGiftCardErrorsCode = /** No gift card is associated with the order. */ | 'GIFT_CARD_NOT_FOUND_FOR_ORDER' /** This order does not exist. */ | 'ORDER_NOT_FOUND'; /** Error codes for failed Storefront Customer Access Token mutation. */ export type UserErrorsStorefrontCustomerAccessTokenCreateUserErrors = DisplayableError & { __typename?: 'UserErrorsStorefrontCustomerAccessTokenCreateUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsStorefrontCustomerAccessTokenCreateUserErrors`. */ export type UserErrorsStorefrontCustomerAccessTokenCreateUserErrorsCode = /** The customer does not exist. */ 'CUSTOMER_DOES_NOT_EXIST'; /** The error codes for failed Stripe Financial Connections session initiation. */ export type UserErrorsStripeFinancialConnectionsSessionUserErrors = DisplayableError & { __typename?: 'UserErrorsStripeFinancialConnectionsSessionUserErrors'; /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ field?: Maybe>; /** The error message. */ message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `UserErrorsStripeFinancialConnectionsSessionUserErrors`. */ export type UserErrorsStripeFinancialConnectionsSessionUserErrorsCode = /** Stripe Financial Connections session could not be initiated. */ 'STRIPE_FINANCIAL_CONNECTIONS_SESSION_ERROR'; /** Represents a Shopify hosted video. */ export type Video = Media & { __typename?: 'Video'; /** A word or phrase to share the nature or contents of a media. */ alt?: Maybe; /** A globally-unique ID. */ id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The preview image for the media. */ previewImage?: Maybe; /** The sources for a video. */ sources: Array; }; /** Represents a source for a Shopify hosted video. */ export type VideoSource = { __typename?: 'VideoSource'; /** The format of the video source. */ format: Scalars['String']['output']; /** The height of the video. */ height: Scalars['Int']['output']; /** The video MIME type. */ mimeType: Scalars['String']['output']; /** The URL of the video. */ url: Scalars['String']['output']; /** The width of the video. */ width: Scalars['Int']['output']; }; /** The configuration used for Payment Wallets. */ export type WalletPaymentConfig = ApplePayWalletConfig | GooglePayWalletConfig; /** * A weight measurement with its numeric value and unit. Used throughout the API, for example in shipping calculations, delivery conditions, order line items, and inventory measurements. * * The weight combines a decimal value with a standard unit of measurement to ensure consistent weight handling across different regional systems. */ export type Weight = { __typename?: 'Weight'; /** The unit of measurement for `value`. */ unit: WeightUnit; /** The weight value using the unit system specified with `unit`. */ value: Scalars['Float']['output']; }; /** Units of measurement for weight. */ export type WeightUnit = /** Metric system unit of mass. */ | 'GRAMS' /** 1 kilogram equals 1000 grams. */ | 'KILOGRAMS' /** Imperial system unit of mass. */ | 'OUNCES' /** 1 pound equals 16 ounces. */ | 'POUNDS';