Skip to content

Instantly share code, notes, and snippets.

@seanonthenet
Created March 30, 2022 13:15
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save seanonthenet/6d34bdcc0b61584e2e9dab91eae7817e to your computer and use it in GitHub Desktop.
Save seanonthenet/6d34bdcc0b61584e2e9dab91eae7817e to your computer and use it in GitHub Desktop.
Shopify Admin API Zeus GraphQL Typescript Types index.ts
This file has been truncated, but you can view the full file.
/* eslint-disable */
import { AllTypesProps, ReturnTypes } from './const';
type ZEUS_INTERFACES =
| GraphQLTypes['AppPurchase']
| GraphQLTypes['CalculatedDiscountApplication']
| GraphQLTypes['CommentEventSubject']
| GraphQLTypes['CustomerMoment']
| GraphQLTypes['DiscountApplication']
| GraphQLTypes['DisplayableError']
| GraphQLTypes['Event']
| GraphQLTypes['File']
| GraphQLTypes['HasEvents']
| GraphQLTypes['HasLocalizationExtensions']
| GraphQLTypes['HasMetafieldDefinitions']
| GraphQLTypes['HasMetafields']
| GraphQLTypes['HasPublishedTranslations']
| GraphQLTypes['LegacyInteroperability']
| GraphQLTypes['Media']
| GraphQLTypes['Navigable']
| GraphQLTypes['Node']
| GraphQLTypes['OnlineStorePreviewable']
| GraphQLTypes['Publishable']
| GraphQLTypes['Sale']
| GraphQLTypes['SalesAgreement']
| GraphQLTypes['SellingPlanPricingPolicyBase']
| GraphQLTypes['ShopifyPaymentsChargeStatementDescriptor'];
type ZEUS_UNIONS =
| GraphQLTypes['AppPricingDetails']
| GraphQLTypes['CommentEventEmbed']
| GraphQLTypes['CustomerPaymentInstrument']
| GraphQLTypes['DeliveryConditionCriteria']
| GraphQLTypes['DeliveryRateProvider']
| GraphQLTypes['DiscountAutomatic']
| GraphQLTypes['DiscountCode']
| GraphQLTypes['DiscountCustomerBuysValue']
| GraphQLTypes['DiscountCustomerGetsValue']
| GraphQLTypes['DiscountCustomerSelection']
| GraphQLTypes['DiscountEffect']
| GraphQLTypes['DiscountItems']
| GraphQLTypes['DiscountMinimumRequirement']
| GraphQLTypes['DiscountShippingDestinationSelection']
| GraphQLTypes['MetafieldReference']
| GraphQLTypes['OrderStagedChange']
| GraphQLTypes['PriceRuleValue']
| GraphQLTypes['PricingValue']
| GraphQLTypes['SellingPlanBillingPolicy']
| GraphQLTypes['SellingPlanDeliveryPolicy']
| GraphQLTypes['SellingPlanPricingPolicy']
| GraphQLTypes['SellingPlanPricingPolicyAdjustmentValue']
| GraphQLTypes['SubscriptionDeliveryMethod']
| GraphQLTypes['SubscriptionDiscount']
| GraphQLTypes['SubscriptionDiscountValue']
| GraphQLTypes['SubscriptionShippingOptionResult']
| GraphQLTypes['TenderTransactionDetails']
| GraphQLTypes['WebhookSubscriptionEndpoint'];
export type ValueTypes = {
/** An Amazon Web Services Amazon Resource Name (ARN), including the Region and account ID.
For more information, refer to [Amazon Resource Names](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). */
['ARN']: unknown;
/** Represents the permission required to access a Shopify Admin API or Storefront API resource for a shop. Access scopes are granted by merchants to requesting applications. */
['AccessScope']: AliasType<{
/** Description of the resource access provided by the access scope when granted to an application. */
description?: boolean;
/** Represents the access scope as a readable string. Typically follows the format `{action}_{resource}`: a `read` or `write` action, followed by the resource on which the action is allowed to be performed on, separated by an underscore. For example, `read_orders`; `write_products`. */
handle?: boolean;
__typename?: boolean;
}>;
/** A sale associated with an order price adjustment. */
['AdjustmentSale']: AliasType<{
/** The type of order action that the sale represents. */
actionType?: boolean;
/** The unique identifier for the sale. */
id?: boolean;
/** The line type assocated with the sale. */
lineType?: boolean;
/** The number of units either ordered or intended to be returned. */
quantity?: boolean;
/** All individual taxes associated with the sale. */
taxes?: ValueTypes['SaleTax'];
/** The total sale amount after taxes and discounts. */
totalAmount?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale after taxes. */
totalDiscountAmountAfterTaxes?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale before taxes. */
totalDiscountAmountBeforeTaxes?: ValueTypes['MoneyBag'];
/** The total amount of taxes for the sale. */
totalTaxAmount?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** Whether all items in the cart are entitled to the discount. */
['AllDiscountItems']: AliasType<{
/** Whether all items are selected. The value is hardcoded to `true`. */
allItems?: boolean;
__typename?: boolean;
}>;
/** A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).
Versions are commonly referred to by their handle (for example, `2021-10`). */
['ApiVersion']: AliasType<{
/** The human-readable name of the version. */
displayName?: boolean;
/** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */
handle?: boolean;
/** Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning). */
supported?: boolean;
__typename?: boolean;
}>;
/** A Shopify application. */
['App']: AliasType<{
/** A unique application API identifier. */
apiKey?: boolean;
/** App store page URL of the app. */
appStoreAppUrl?: boolean;
/** App store page URL of the developer who created the app. */
appStoreDeveloperUrl?: boolean;
/** Banner image for the app. */
banner?: ValueTypes['Image'];
/** Description of the app. */
description?: boolean;
/** The name of the app developer. */
developerName?: boolean;
/** Website of the developer who created the app. */
developerUrl?: boolean;
/** Whether the app uses the Embedded App SDK. */
embedded?: boolean;
/** Requirements that must be met before the app can be installed. */
failedRequirements?: ValueTypes['FailedRequirement'];
/** A list of app features that are shown in the Shopify App Store listing. */
features?: boolean;
/** Feedback from this app about the store. */
feedback?: ValueTypes['AppFeedback'];
/** Handle of the app. */
handle?: boolean;
/** Icon that represents the app. */
icon?: ValueTypes['Image'];
/** A globally-unique identifier. */
id?: boolean;
/** Webpage where you can install the app. */
installUrl?: boolean;
/** Corresponding AppInstallation for this shop and App.
Returns null if the App is not installed. */
installation?: ValueTypes['AppInstallation'];
/** Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use. */
isPostPurchaseAppInUse?: boolean;
/** Webpage that the app starts in. */
launchUrl?: boolean;
/** Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin. */
navigationItems?: ValueTypes['NavigationItem'];
/** Detailed information about the app pricing. */
pricingDetails?: boolean;
/** Summary of the app pricing details. */
pricingDetailsSummary?: boolean;
/** Link to app privacy policy. */
privacyPolicyUrl?: boolean;
/** Whether the app is published to the Shopify App Store. */
published?: boolean;
/** Screenshots of the app. */
screenshots?: ValueTypes['Image'];
/** Whether the app was developed by Shopify. */
shopifyDeveloped?: boolean;
/** Name of the app. */
title?: boolean;
/** Message that appears when the app is uninstalled. For example:
By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time. */
uninstallMessage?: boolean;
/** Webpage where you can uninstall the app. */
uninstallUrl?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Apps. */
['AppConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['AppEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify. */
['AppCredit']: AliasType<{
/** The amount that can be used towards future app purchases in Shopify. */
amount?: ValueTypes['MoneyV2'];
/** The date and time when the app credit was created. */
createdAt?: boolean;
/** The description of the app credit. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Whether the app credit is a test transaction. */
test?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple AppCredits. */
['AppCreditConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['AppCreditEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `appCreditCreate` mutation. */
['AppCreditCreatePayload']: AliasType<{
/** The newly created app credit. */
appCredit?: ValueTypes['AppCredit'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one AppCredit and a cursor during pagination. */
['AppCreditEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of AppCreditEdge. */
node?: ValueTypes['AppCredit'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one App and a cursor during pagination. */
['AppEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of AppEdge. */
node?: ValueTypes['App'];
__typename?: boolean;
}>;
/** Reports the status of shops and their resources and displays this information
within Shopify admin. AppFeedback is used to notify merchants about steps they need to take
to set up an app on their store. */
['AppFeedback']: AliasType<{
/** The application associated to the feedback. */
app?: ValueTypes['App'];
/** A link to where merchants can resolve errors. */
link?: ValueTypes['Link'];
/** The feedback message presented to the merchant. */
messages?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents an installed application on a shop. */
['AppInstallation']: AliasType<{
/** The access scopes granted to the application by a merchant during installation. */
accessScopes?: ValueTypes['AccessScope'];
/** The active application subscriptions billed to the shop on a recurring basis. */
activeSubscriptions?: ValueTypes['AppSubscription'];
allSubscriptions?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AppSubscriptionSortKeys'] | null;
},
ValueTypes['AppSubscriptionConnection']
];
/** Application which is installed. */
app?: ValueTypes['App'];
/** Channel associated with the installed application. */
channel?: ValueTypes['Channel'];
credits?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AppTransactionSortKeys'] | null;
},
ValueTypes['AppCreditConnection']
];
/** A globally-unique identifier. */
id?: boolean;
/** The URL to launch the application. */
launchUrl?: boolean;
oneTimePurchases?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AppTransactionSortKeys'] | null;
},
ValueTypes['AppPurchaseOneTimeConnection']
];
/** The publication associated with the installed application. */
publication?: ValueTypes['Publication'];
revenueAttributionRecords?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AppRevenueAttributionRecordSortKeys'] | null;
},
ValueTypes['AppRevenueAttributionRecordConnection']
];
/** Subscriptions charge to a shop on a recurring basis. */
subscriptions?: ValueTypes['AppSubscription'];
/** The URL to uninstall the application. */
uninstallUrl?: boolean;
__typename?: boolean;
}>;
/** The possible categories of an app installation, based on their purpose
or the environment they can run in. */
['AppInstallationCategory']: AppInstallationCategory;
/** An auto-generated type for paginating through multiple AppInstallations. */
['AppInstallationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['AppInstallationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one AppInstallation and a cursor during pagination. */
['AppInstallationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of AppInstallationEdge. */
node?: ValueTypes['AppInstallation'];
__typename?: boolean;
}>;
/** The levels of privacy of an app installation. */
['AppInstallationPrivacy']: AppInstallationPrivacy;
/** The set of valid sort keys for the AppInstallation query. */
['AppInstallationSortKeys']: AppInstallationSortKeys;
/** The pricing model for the app subscription.
The pricing model input can be either `appRecurringPricingDetails` or `appUsagePricingDetails`. */
['AppPlanInput']: {
/** The pricing details for usage-based billing. */
appUsagePricingDetails?: ValueTypes['AppUsagePricingInput'] | null;
/** The pricing details for recurring billing. */
appRecurringPricingDetails?: ValueTypes['AppRecurringPricingInput'] | null;
};
/** The app plan that the merchant is subscribed to. */
['AppPlanV2']: AliasType<{
/** The plan billed to a shop on a recurring basis. */
pricingDetails?: ValueTypes['AppPricingDetails'];
__typename?: boolean;
}>;
/** The information about the price that's charged to a shop every plan period.
The concrete type can be `AppRecurringPricing` for recurring billing or `AppUsagePricing` for usage-based billing. */
['AppPricingDetails']: AliasType<{
['...on AppRecurringPricing']: ValueTypes['AppRecurringPricing'];
['...on AppUsagePricing']: ValueTypes['AppUsagePricing'];
__typename?: boolean;
}>;
/** The frequency at which the shop is billed for an app subscription. */
['AppPricingInterval']: AppPricingInterval;
/** Services and features purchased once by the store. */
['AppPurchase']: AliasType<{
/** The date and time when the app purchase occurred. */
createdAt?: boolean;
/** The name of the app purchase. */
name?: boolean;
/** The amount to be charged to the store for the app purchase. */
price?: ValueTypes['MoneyV2'];
/** The status of the app purchase. */
status?: boolean;
/** Whether the app purchase is a test transaction. */
test?: boolean;
['...on AppPurchaseOneTime']?: Omit<ValueTypes['AppPurchaseOneTime'], keyof ValueTypes['AppPurchase']>;
__typename?: boolean;
}>;
/** Services and features purchased once by a store. */
['AppPurchaseOneTime']: AliasType<{
/** The date and time when the app purchase occurred. */
createdAt?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The name of the app purchase. */
name?: boolean;
/** The amount to be charged to the store for the app purchase. */
price?: ValueTypes['MoneyV2'];
/** The status of the app purchase. */
status?: boolean;
/** Whether the app purchase is a test transaction. */
test?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple AppPurchaseOneTimes. */
['AppPurchaseOneTimeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['AppPurchaseOneTimeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `appPurchaseOneTimeCreate` mutation. */
['AppPurchaseOneTimeCreatePayload']: AliasType<{
/** The newly created app one-time purchase. */
appPurchaseOneTime?: ValueTypes['AppPurchaseOneTime'];
/** The URL that the merchant can access to approve or decline the newly created app one-time purchase.
If the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined.
If the merchant approves and they're successfully invoiced, then the state of the charge changes from `pending` to `active`.
You get paid after the charge is activated. */
confirmationUrl?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination. */
['AppPurchaseOneTimeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of AppPurchaseOneTimeEdge. */
node?: ValueTypes['AppPurchaseOneTime'];
__typename?: boolean;
}>;
/** The approval status of the app purchase.
The merchant is charged for the purchase immediately after approval, and the status changes to `active`.
If the payment fails, then the app purchase remains `pending`.
Purchases start as `pending` and can change to: `active`, `declined`, `expired`. After a purchase changes, it
remains in that final state. */
['AppPurchaseStatus']: AppPurchaseStatus;
/** The pricing information about a subscription app.
The object contains an interval (the frequency at which the shop is billed for an app subscription) and
a price (the amount to be charged to the subscribing shop at each interval). */
['AppRecurringPricing']: AliasType<{
/** The frequency at which the subscribing shop is billed for an app subscription. */
interval?: boolean;
/** The amount and currency to be charged to the subscribing shop every billing interval. */
price?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** Instructs the app subscription to generate a fixed charge on a recurring basis. The frequency is specified by the billing interval. */
['AppRecurringPricingInput']: {
/** How often the app subscription generates a charge. */
interval?: ValueTypes['AppPricingInterval'] | null;
/** The amount to be charged to the store every billing interval. The only permitted currency code is USD. */
price: ValueTypes['MoneyInput'];
};
/** Represents app revenue that was captured externally by the partner. */
['AppRevenueAttributionRecord']: AliasType<{
/** The financial amount captured in this attribution. */
amount?: ValueTypes['MoneyV2'];
/** The timestamp when the financial amount was captured. */
capturedAt?: boolean;
/** The timestamp at which this revenue attribution was issued. */
createdAt?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The unique value submitted during the creation of the app revenue attribution record.
For more information, refer to
[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */
idempotencyKey?: boolean;
/** Indicates whether this is a test submission. */
test?: boolean;
/** The type of revenue attribution. */
type?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple AppRevenueAttributionRecords. */
['AppRevenueAttributionRecordConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['AppRevenueAttributionRecordEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `appRevenueAttributionRecordCreate` mutation. */
['AppRevenueAttributionRecordCreatePayload']: AliasType<{
/** The created app revenue attribution record. */
appRevenueAttributionRecord?: ValueTypes['AppRevenueAttributionRecord'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['AppRevenueAttributionRecordCreateUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `AppRevenueAttributionRecordCreate`. */
['AppRevenueAttributionRecordCreateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `AppRevenueAttributionRecordCreateUserError`. */
['AppRevenueAttributionRecordCreateUserErrorCode']: AppRevenueAttributionRecordCreateUserErrorCode;
/** Return type for `appRevenueAttributionRecordDelete` mutation. */
['AppRevenueAttributionRecordDeletePayload']: AliasType<{
/** The ID of the revenue attribution that was deleted, if one was. */
deletedId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['AppRevenueAttributionRecordDeleteUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `AppRevenueAttributionRecordDelete`. */
['AppRevenueAttributionRecordDeleteUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `AppRevenueAttributionRecordDeleteUserError`. */
['AppRevenueAttributionRecordDeleteUserErrorCode']: AppRevenueAttributionRecordDeleteUserErrorCode;
/** An auto-generated type which holds one AppRevenueAttributionRecord and a cursor during pagination. */
['AppRevenueAttributionRecordEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of AppRevenueAttributionRecordEdge. */
node?: ValueTypes['AppRevenueAttributionRecord'];
__typename?: boolean;
}>;
/** Allows to supply an app revenue attribution record. */
['AppRevenueAttributionRecordInput']: {
/** The unique value submitted during creation.
For more information, refer to
[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */
idempotencyKey: string;
/** The timestamp when the financial amount was captured. */
capturedAt: ValueTypes['DateTime'];
/** The financial amount captured in this attribution. */
amount: ValueTypes['MoneyInput'];
/** The type of revenue attribution. */
type: ValueTypes['AppRevenueAttributionType'];
/** Indicates whether this is a test submission. */
test: boolean;
};
/** The set of valid sort keys for the AppRevenueAttributionRecord query. */
['AppRevenueAttributionRecordSortKeys']: AppRevenueAttributionRecordSortKeys;
/** Represents the billing types of revenue attribution. */
['AppRevenueAttributionType']: AppRevenueAttributionType;
/** Provides users access to services and/or features for a duration of time. */
['AppSubscription']: AliasType<{
/** The date and time when the app subscription was created. */
createdAt?: boolean;
/** The date and time when the current app subscription period ends. */
currentPeriodEnd?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The plans attached to the app subscription. */
lineItems?: ValueTypes['AppSubscriptionLineItem'];
/** The name of the app subscription. */
name?: boolean;
/** The URL that the merchant is redirected to after approving the app subscription. */
returnUrl?: boolean;
/** The status of the app subscription. */
status?: boolean;
/** Specifies whether the app subscription is a test transaction. */
test?: boolean;
/** The number of free trial days, starting at the subscription's creation date, by which billing is delayed. */
trialDays?: boolean;
__typename?: boolean;
}>;
/** Return type for `appSubscriptionCancel` mutation. */
['AppSubscriptionCancelPayload']: AliasType<{
/** The cancelled app subscription. */
appSubscription?: ValueTypes['AppSubscription'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple AppSubscriptions. */
['AppSubscriptionConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['AppSubscriptionEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `appSubscriptionCreate` mutation. */
['AppSubscriptionCreatePayload']: AliasType<{
/** The newly-created app subscription. */
appSubscription?: ValueTypes['AppSubscription'];
/** The URL pointing to the page where the merchant approves or declines the charges for an app subscription. */
confirmationUrl?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one AppSubscription and a cursor during pagination. */
['AppSubscriptionEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of AppSubscriptionEdge. */
node?: ValueTypes['AppSubscription'];
__typename?: boolean;
}>;
/** The plan attached to an app subscription. */
['AppSubscriptionLineItem']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The pricing model for the app subscription. */
plan?: ValueTypes['AppPlanV2'];
usageRecords?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AppUsageRecordSortKeys'] | null;
},
ValueTypes['AppUsageRecordConnection']
];
__typename?: boolean;
}>;
/** Allows an app to add more than one pricing plan to an app subscription. */
['AppSubscriptionLineItemInput']: {
/** The pricing model for the app subscription. */
plan: ValueTypes['AppPlanInput'];
};
/** Return type for `appSubscriptionLineItemUpdate` mutation. */
['AppSubscriptionLineItemUpdatePayload']: AliasType<{
/** The updated app subscription. */
appSubscription?: ValueTypes['AppSubscription'];
/** The URL where the merchant approves or declines the updated app subscription line item. */
confirmationUrl?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the AppSubscription query. */
['AppSubscriptionSortKeys']: AppSubscriptionSortKeys;
/** The status of the app subscription. */
['AppSubscriptionStatus']: AppSubscriptionStatus;
/** The set of valid sort keys for the AppTransaction query. */
['AppTransactionSortKeys']: AppTransactionSortKeys;
/** Defines a usage pricing model for the app subscription.
These charges are variable based on how much the merchant uses the app. */
['AppUsagePricing']: AliasType<{
/** The total usage records for interval. */
balanceUsed?: ValueTypes['MoneyV2'];
/** The capped amount prevents the merchant from being charged for any usage over that amount during a billing period.
This prevents billing from exceeding a maximum threshold over the duration of the billing period.
For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. */
cappedAmount?: ValueTypes['MoneyV2'];
/** The frequency with which the app usage records are billed. */
interval?: boolean;
/** The terms and conditions for app usage pricing.
Must be present in order to create usage charges.
The terms are presented to the merchant when they approve an app's usage charges. */
terms?: boolean;
__typename?: boolean;
}>;
/** Allows an app to issue arbitrary charges for app usage associated with a subscription. */
['AppUsagePricingInput']: {
/** The maximum amount of usage charges that can be incurred within a subscription billing interval. */
cappedAmount: ValueTypes['MoneyInput'];
/** The terms and conditions for app usage. These terms stipulate the pricing model for the charges that an app creates. */
terms: string;
};
/** Store usage for app subscriptions with usage pricing. */
['AppUsageRecord']: AliasType<{
/** The date and time when the usage record was created. */
createdAt?: boolean;
/** The description of the app usage record. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The price of the usage record. The only permitted currency code is USD. */
price?: ValueTypes['MoneyV2'];
/** Defines the usage pricing plan the merchant is subscribed to. */
subscriptionLineItem?: ValueTypes['AppSubscriptionLineItem'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple AppUsageRecords. */
['AppUsageRecordConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['AppUsageRecordEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `appUsageRecordCreate` mutation. */
['AppUsageRecordCreatePayload']: AliasType<{
/** The newly created app usage record. */
appUsageRecord?: ValueTypes['AppUsageRecord'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one AppUsageRecord and a cursor during pagination. */
['AppUsageRecordEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of AppUsageRecordEdge. */
node?: ValueTypes['AppUsageRecord'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the AppUsageRecord query. */
['AppUsageRecordSortKeys']: AppUsageRecordSortKeys;
/** Represents a generic custom attribute. */
['Attribute']: AliasType<{
/** Key or name of the attribute. */
key?: boolean;
/** Value of the attribute. */
value?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields required for an attribute. */
['AttributeInput']: {
/** Key or name of the attribute. */
key: string;
/** Value of the attribute. */
value: string;
};
/** Automatic discount applications capture the intentions of a discount that was automatically applied. */
['AutomaticDiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** An ordered index that can be used to identify the discount application and indicate the precedence
of the discount application for calculations. */
index?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The title of the discount application. */
title?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the AutomaticDiscount query. */
['AutomaticDiscountSortKeys']: AutomaticDiscountSortKeys;
/** Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or
the addition of a product. */
['BasicEvent']: AliasType<{
/** The name of the app that created the event. */
appTitle?: boolean;
/** Whether the event was created by an app. */
attributeToApp?: boolean;
/** Whether the event was caused by an admin user. */
attributeToUser?: boolean;
/** The date and time when the event was created. */
createdAt?: boolean;
/** Whether the event is critical. */
criticalAlert?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Human readable text that describes the event. */
message?: boolean;
__typename?: boolean;
}>;
/** Represents an error that happens during the execution of a billing attempt mutation. */
['BillingAttemptUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `BillingAttemptUserError`. */
['BillingAttemptUserErrorCode']: BillingAttemptUserErrorCode;
/** Possible error codes that can be returned by `BulkMutationUserError`. */
['BulkMutationErrorCode']: BulkMutationErrorCode;
/** Represents an error that happens during execution of a bulk mutation. */
['BulkMutationUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** An asynchronous long-running operation to fetch data in bulk or to bulk import data.
Bulk operations are created using the `bulkOperationRunQuery` or `bulkOperationRunMutation` mutation. After
they are created, clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains
a link to the data in [JSONL](http://jsonlines.org/) format.
Refer to the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details. */
['BulkOperation']: AliasType<{
/** When the bulk operation was successfully completed. */
completedAt?: boolean;
/** When the bulk operation was created. */
createdAt?: boolean;
/** Error code for failed operations. */
errorCode?: boolean;
/** File size in bytes of the file in the `url` field. */
fileSize?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** A running count of all the objects processed.
For example, when fetching all the products and their variants, this field counts both products and variants.
This field can be used to track operation progress. */
objectCount?: boolean;
/** The URL that points to the partial or incomplete response data (in [JSONL](http://jsonlines.org/) format) that was returned by a failed operation.
The URL expires 7 days after the operation fails. Returns `null` when there's no data available. */
partialDataUrl?: boolean;
/** GraphQL query document specified in `bulkOperationRunQuery`. */
query?: boolean;
/** A running count of all the objects that are processed at the root of the query.
For example, when fetching all the products and their variants, this field only counts products.
This field can be used to track operation progress. */
rootObjectCount?: boolean;
/** Status of the bulk operation. */
status?: boolean;
/** The bulk operation's type. */
type?: boolean;
/** The URL that points to the response data in [JSONL](http://jsonlines.org/) format.
The URL expires 7 days after the operation completes. */
url?: boolean;
__typename?: boolean;
}>;
/** Return type for `bulkOperationCancel` mutation. */
['BulkOperationCancelPayload']: AliasType<{
/** The bulk operation to be canceled. */
bulkOperation?: ValueTypes['BulkOperation'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Error codes for failed bulk operations. */
['BulkOperationErrorCode']: BulkOperationErrorCode;
/** Return type for `bulkOperationRunMutation` mutation. */
['BulkOperationRunMutationPayload']: AliasType<{
/** The newly created bulk operation. */
bulkOperation?: ValueTypes['BulkOperation'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['BulkMutationUserError'];
__typename?: boolean;
}>;
/** Return type for `bulkOperationRunQuery` mutation. */
['BulkOperationRunQueryPayload']: AliasType<{
/** The newly created bulk operation. */
bulkOperation?: ValueTypes['BulkOperation'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The valid values for the status of a bulk operation. */
['BulkOperationStatus']: BulkOperationStatus;
/** The valid values for the bulk operation's type. */
['BulkOperationType']: BulkOperationType;
/** Return type for `bulkProductResourceFeedbackCreate` mutation. */
['BulkProductResourceFeedbackCreatePayload']: AliasType<{
/** The feedback that is created. */
feedback?: ValueTypes['ProductResourceFeedback'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['BulkProductResourceFeedbackCreateUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `BulkProductResourceFeedbackCreate`. */
['BulkProductResourceFeedbackCreateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `BulkProductResourceFeedbackCreateUserError`. */
['BulkProductResourceFeedbackCreateUserErrorCode']: BulkProductResourceFeedbackCreateUserErrorCode;
/** A discount that is automatically applied to an order that is being edited. */
['CalculatedAutomaticDiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The level at which the discount was applied. */
appliedTo?: boolean;
/** The description of discount application. Indicates the reason why the discount was applied. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** An amount discounting the line that has been allocated by an associated discount application. */
['CalculatedDiscountAllocation']: AliasType<{
/** The money amount allocated by the discount application in shop and presentment currencies. */
allocatedAmountSet?: ValueTypes['MoneyBag'];
/** The discount that the allocated amount originated from. */
discountApplication?: ValueTypes['CalculatedDiscountApplication'];
__typename?: boolean;
}>;
/** A [discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/discountapplication) involved in order editing that might be newly added or have new changes applied. */
['CalculatedDiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The level at which the discount was applied. */
appliedTo?: boolean;
/** The description of discount application. Indicates the reason why the discount was applied. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
['...on CalculatedAutomaticDiscountApplication']?: Omit<
ValueTypes['CalculatedAutomaticDiscountApplication'],
keyof ValueTypes['CalculatedDiscountApplication']
>;
['...on CalculatedDiscountCodeApplication']?: Omit<
ValueTypes['CalculatedDiscountCodeApplication'],
keyof ValueTypes['CalculatedDiscountApplication']
>;
['...on CalculatedManualDiscountApplication']?: Omit<
ValueTypes['CalculatedManualDiscountApplication'],
keyof ValueTypes['CalculatedDiscountApplication']
>;
['...on CalculatedScriptDiscountApplication']?: Omit<
ValueTypes['CalculatedScriptDiscountApplication'],
keyof ValueTypes['CalculatedDiscountApplication']
>;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple CalculatedDiscountApplications. */
['CalculatedDiscountApplicationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CalculatedDiscountApplicationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one CalculatedDiscountApplication and a cursor during pagination. */
['CalculatedDiscountApplicationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CalculatedDiscountApplicationEdge. */
node?: ValueTypes['CalculatedDiscountApplication'];
__typename?: boolean;
}>;
/** A discount code that is applied to an order that is being edited. */
['CalculatedDiscountCodeApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The level at which the discount was applied. */
appliedTo?: boolean;
/** The string identifying the discount code that was used at the time of application. */
code?: boolean;
/** The description of discount application. Indicates the reason why the discount was applied. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** The computed properties for a draft order. */
['CalculatedDraftOrder']: AliasType<{
/** Order-level discount applied to the draft order. */
appliedDiscount?: ValueTypes['DraftOrderAppliedDiscount'];
/** The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item. */
availableShippingRates?: ValueTypes['ShippingRate'];
/** Customer who will be sent an invoice for the draft order, if there is one. */
customer?: ValueTypes['Customer'];
/** Line items in the draft order with their computed properties. */
lineItems?: ValueTypes['CalculatedDraftOrderLineItem'];
/** Line item that contains the shipping costs. */
shippingLine?: ValueTypes['ShippingLine'];
/** Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes). */
subtotalPrice?: boolean;
/** Total amount of taxes charged for each line item and shipping line. */
taxLines?: ValueTypes['TaxLine'];
/** Total amount of the draft order (includes taxes, shipping charges, and discounts). */
totalPrice?: boolean;
/** Total shipping charge for the draft order. */
totalShippingPrice?: boolean;
/** Total amount of taxes for the draft order. */
totalTax?: boolean;
__typename?: boolean;
}>;
/** The computed line items for a draft order. */
['CalculatedDraftOrderLineItem']: AliasType<{
/** Discount applied to the line item. */
appliedDiscount?: ValueTypes['DraftOrderAppliedDiscount'];
/** Indicates if this is a product variant line item, or a custom line item. */
custom?: boolean;
/** List of additional information about the line item. */
customAttributes?: ValueTypes['Attribute'];
/** Total price with discounts applied. */
discountedTotal?: ValueTypes['MoneyV2'];
/** Unit price with discounts applied. */
discountedUnitPrice?: ValueTypes['MoneyV2'];
/** Name of the service provider who fulfilled the order.
Valid values are either **manual** or the name of the provider.
For example, **amazon**, **shipwire**.
Deleted fulfillment services will return null. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** Image associated with the draft order line item. */
image?: ValueTypes['Image'];
/** Indicates whether the line item represents the puchase of a gift card. */
isGiftCard?: boolean;
/** Name of the product. */
name?: boolean;
/** Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. */
originalTotal?: ValueTypes['MoneyV2'];
/** Variant price without any discounts applied. */
originalUnitPrice?: ValueTypes['MoneyV2'];
/** Product associated with the draft order line item. */
product?: ValueTypes['Product'];
/** Number of variant items requested in the draft order. */
quantity?: boolean;
/** Whether physical shipping is required for the variant. */
requiresShipping?: boolean;
/** Variant SKU number. */
sku?: boolean;
/** Whether the variant is taxable. */
taxable?: boolean;
/** Title of the product or variant (this field only applies to custom line items). */
title?: boolean;
/** Total value of the discount. */
totalDiscount?: ValueTypes['MoneyV2'];
/** Variant associated with the draft order line item. */
variant?: ValueTypes['ProductVariant'];
/** Name of the variant. */
variantTitle?: boolean;
/** Name of the vendor who made the variant. */
vendor?: boolean;
/** Weight unit and value for a draft order line item. */
weight?: ValueTypes['Weight'];
__typename?: boolean;
}>;
/** A line item involved in order editing that may be newly added or have new changes applied. */
['CalculatedLineItem']: AliasType<{
/** The discounts that have been allocated onto the line item by discount applications. */
calculatedDiscountAllocations?: ValueTypes['CalculatedDiscountAllocation'];
/** The list of additional information about the line item. */
customAttributes?: ValueTypes['Attribute'];
/** The discounts that have been allocated onto the line item by discount applications. */
discountAllocations?: ValueTypes['DiscountAllocation'];
/** The price of a single quantity of the line item with line item discounts applied, in shop and presentment currencies. Discounts applied to the entire order aren't included in this price. */
discountedUnitPriceSet?: ValueTypes['MoneyBag'];
/** The total number of items that can be edited. */
editableQuantity?: boolean;
/** The editable quantity prior to any changes made in the current edit. */
editableQuantityBeforeChanges?: boolean;
/** The total price of editable lines in shop and presentment currencies. */
editableSubtotalSet?: ValueTypes['MoneyBag'];
/** Whether the calculated line item has a staged discount. */
hasStagedLineItemDiscount?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The image object associated to the line item's variant. */
image?: ValueTypes['Image'];
/** The variant unit price in shop and presentment currencies, without any discounts applied. */
originalUnitPriceSet?: ValueTypes['MoneyBag'];
/** The total number of items. */
quantity?: boolean;
/** Whether the line item can be restocked or not. */
restockable?: boolean;
/** Whether the changes on the line item will result in a restock. */
restocking?: boolean;
/** The variant SKU number. */
sku?: boolean;
/** A list of changes that affect this line item. */
stagedChanges?: ValueTypes['OrderStagedChange'];
/** The title of the product. */
title?: boolean;
/** The total price of uneditable lines in shop and presentment currencies. */
uneditableSubtotalSet?: ValueTypes['MoneyBag'];
/** The product variant associated with this line item. The value is null for custom line items and items where
the variant has been deleted. */
variant?: ValueTypes['ProductVariant'];
/** The title of the variant. */
variantTitle?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple CalculatedLineItems. */
['CalculatedLineItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CalculatedLineItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one CalculatedLineItem and a cursor during pagination. */
['CalculatedLineItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CalculatedLineItemEdge. */
node?: ValueTypes['CalculatedLineItem'];
__typename?: boolean;
}>;
/** Represents a discount that was manually created for an order that is being edited. */
['CalculatedManualDiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The level at which the discount was applied. */
appliedTo?: boolean;
/** The description of discount application. Indicates the reason why the discount was applied. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** An order with edits applied but not saved. */
['CalculatedOrder']: AliasType<{
addedDiscountApplications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CalculatedDiscountApplicationConnection']
];
addedLineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CalculatedLineItemConnection']
];
/** Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies. */
cartDiscountAmountSet?: ValueTypes['MoneyBag'];
/** Whether the changes have been applied and saved to the order. */
committed?: boolean;
/** A globally-unique identifier. */
id?: boolean;
lineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `editable`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['CalculatedLineItemConnection']
];
/** The HTML of the customer notification for the order edit. */
notificationPreviewHtml?: boolean;
/** The customer notification title. */
notificationPreviewTitle?: boolean;
/** The order without any changes applied. */
order?: ValueTypes['Order'];
/** The order without any changes applied. */
originalOrder?: ValueTypes['Order'];
stagedChanges?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['OrderStagedChangeConnection']
];
/** The sum of the quantities for the line items that contribute to the order's subtotal. */
subtotalLineItemsQuantity?: boolean;
/** The subtotal of the line items, in shop and presentment currencies, after all the discounts are applied. The subtotal does not include shipping. The subtotal includes taxes for taxes-included orders and excludes taxes for taxes-excluded orders. */
subtotalPriceSet?: ValueTypes['MoneyBag'];
/** Taxes charged for the line item. */
taxLines?: ValueTypes['TaxLine'];
/** Total price of the order less the total amount received from the customer in shop and presentment currencies. */
totalOutstandingSet?: ValueTypes['MoneyBag'];
/** Total amount of the order (includes taxes and discounts) in shop and presentment currencies. */
totalPriceSet?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** A discount created by a Shopify script for an order that is being edited. */
['CalculatedScriptDiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The level at which the discount was applied. */
appliedTo?: boolean;
/** The description of discount application. Indicates the reason why the discount was applied. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** A channel represents an app where you sell a group of products and collections.
A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. */
['Channel']: AliasType<{
/** Underlying app used by the channel. */
app?: ValueTypes['App'];
collectionPublicationsV3?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationConnection']
];
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CollectionConnection']
];
/** Unique identifier for the channel. */
handle?: boolean;
hasCollection?: [
{
/** Collection ID to check. */
id: string;
},
boolean
];
/** A globally-unique identifier. */
id?: boolean;
/** Name of the channel. */
name?: boolean;
/** Menu items for the channel, which also appear as submenu items in left navigation sidebar in the Shopify admin. */
navigationItems?: ValueTypes['NavigationItem'];
/** Home page for the channel. */
overviewPath?: boolean;
productPublications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductPublicationConnection']
];
productPublicationsV3?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductConnection']
];
/** Whether or not this channel supports future publishing. */
supportsFuturePublishing?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Channels. */
['ChannelConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ChannelEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Channel and a cursor during pagination. */
['ChannelEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ChannelEdge. */
node?: ValueTypes['Channel'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the CodeDiscount query. */
['CodeDiscountSortKeys']: CodeDiscountSortKeys;
/** Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.
Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.
Collections can also be created for a custom group of products. These are called custom or manual collections. */
['Collection']: AliasType<{
/** The number of publications a resource is published to without feedback errors. */
availablePublicationCount?: boolean;
description?: [
{
/** Truncates string after the given length. */
truncateAt?: number | null;
},
boolean
];
/** The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme. */
descriptionHtml?: boolean;
/** Information about the collection that's provided through resource feedback. */
feedback?: ValueTypes['ResourceFeedback'];
/** A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title `Summer Catalog 2022` might have the handle `summer-catalog-2022`.
If the title is changed, the handle doesn't automatically change.
The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes. */
handle?: boolean;
hasProduct?: [
{
/** The ID of the product to check. */
id: string;
},
boolean
];
/** A globally-unique identifier. */
id?: boolean;
image?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafieldDefinitions?: [
{
/** Filter metafield definitions by namespace. */
namespace?: string | null /** Filter by the definition's pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductCollectionSortKeys'] | null;
},
ValueTypes['ProductConnection']
];
/** The number of products in the collection. */
productsCount?: boolean;
publicationCount?: [
{
/** Include only the resource's publications that are published. If false, then return all the resource's publications including future publications. */
onlyPublished?: boolean | null;
},
boolean
];
publications?: [
{
/** Whether or not to return only the collection publications that are published. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CollectionPublicationConnection']
];
publishedOnChannel?: [
{
/** The ID of the channel to check. */
channelId: string;
},
boolean
];
/** Check to see whether the resource is published to the calling app's channel. */
publishedOnCurrentChannel?: boolean;
/** Check to see whether the resource is published to the calling app's publication. */
publishedOnCurrentPublication?: boolean;
publishedOnPublication?: [
{
/** The ID of the publication to check. */
publicationId: string;
},
boolean
];
resourcePublications?: [
{
/** Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationConnection']
];
resourcePublicationsV2?: [
{
/** Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationV2Connection']
];
/** For a smart (automated) collection, specifies the rules that determine whether a product is included. */
ruleSet?: ValueTypes['CollectionRuleSet'];
/** If the default SEO fields for page title and description have been modified, contains the modified information. */
seo?: ValueTypes['SEO'];
/** The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store. */
sortOrder?: boolean;
/** The Storefront GraphQL API ID of the `Collection`.
As of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead. */
storefrontId?: boolean;
/** The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template. If the value is `null`, then the collection is using the default `collection.liquid` template. */
templateSuffix?: boolean;
/** The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store. */
title?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
unpublishedChannels?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ChannelConnection']
];
unpublishedPublications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PublicationConnection']
];
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** Return type for `collectionAddProducts` mutation. */
['CollectionAddProductsPayload']: AliasType<{
/** The updated collection. */
collection?: ValueTypes['Collection'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Collections. */
['CollectionConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CollectionEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `collectionCreate` mutation. */
['CollectionCreatePayload']: AliasType<{
/** The collection that has been created. */
collection?: ValueTypes['Collection'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the collection to delete. */
['CollectionDeleteInput']: {
/** The ID of the collection to be deleted. */
id: string;
};
/** Return type for `collectionDelete` mutation. */
['CollectionDeletePayload']: AliasType<{
/** The ID of the collection that was deleted. */
deletedCollectionId?: boolean;
/** The shop associated with the collection. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Collection and a cursor during pagination. */
['CollectionEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CollectionEdge. */
node?: ValueTypes['Collection'];
__typename?: boolean;
}>;
/** Specifies the input fields required to create a collection. */
['CollectionInput']: {
/** The description of the collection, in HTML format. */
descriptionHtml?: string | null;
/** A unique human-friendly string for the collection. Automatically generated from the collection's title. */
handle?: string | null;
/** Specifies the collection to update or create a new collection if absent. */
id?: string | null;
/** The image associated with the collection. */
image?: ValueTypes['ImageInput'] | null;
/** Initial list of collection products. Only valid with `productCreate` and without rules. */
products?: string[];
/** Initial list of collection publications. Only valid with `productCreate`. This argument is deprecated: Use PublishablePublish instead. */
publications?: ValueTypes['CollectionPublicationInput'][];
/** The private metafields to associated with this product. */
privateMetafields?: ValueTypes['PrivateMetafieldInput'][];
/** The rules used to assign products to the collection. */
ruleSet?: ValueTypes['CollectionRuleSetInput'] | null;
/** The theme template used when viewing the collection in a store. */
templateSuffix?: string | null;
/** The order in which the collection's products are sorted. */
sortOrder?: ValueTypes['CollectionSortOrder'] | null;
/** Required for creating a new collection. */
title?: string | null;
/** The metafields to associate with this collection. */
metafields?: ValueTypes['MetafieldInput'][];
/** SEO information for the collection. */
seo?: ValueTypes['SEOInput'] | null;
/** Indicates whether a redirect is required after a new handle has been provided.
If true, then the old handle is redirected to the new one automatically. */
redirectNewHandle?: boolean | null;
};
/** Represents the publications where a collection is published. */
['CollectionPublication']: AliasType<{
/** The channel where the collection will be published. */
channel?: ValueTypes['Channel'];
/** The collection to be published on the publication. */
collection?: ValueTypes['Collection'];
/** Whether the publication is published or not. */
isPublished?: boolean;
/** The publication where the collection will be published. */
publication?: ValueTypes['Publication'];
/** The date that the publication was or is going to be published. */
publishDate?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple CollectionPublications. */
['CollectionPublicationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CollectionPublicationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one CollectionPublication and a cursor during pagination. */
['CollectionPublicationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CollectionPublicationEdge. */
node?: ValueTypes['CollectionPublication'];
__typename?: boolean;
}>;
/** Specifies the publications to which a collection will be published. */
['CollectionPublicationInput']: {
/** The ID of the publication. */
publicationId?: string | null;
/** The ID of the channel. This argument is deprecated: Use publicationId instead. */
channelId?: string | null;
/** This argument is deprecated: Use publicationId instead. */
channelHandle?: string | null;
};
/** Specifies a collection to publish and the sales channels to publish it to. */
['CollectionPublishInput']: {
/** The collection to create or update publications for. */
id: string;
/** The channels where the collection will be published. */
collectionPublications: ValueTypes['CollectionPublicationInput'][];
};
/** Return type for `collectionPublish` mutation. */
['CollectionPublishPayload']: AliasType<{
/** The published collection. */
collection?: ValueTypes['Collection'];
/** The channels where the collection has been published. */
collectionPublications?: ValueTypes['CollectionPublication'];
/** The shop associated with the collection. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `collectionRemoveProducts` mutation. */
['CollectionRemoveProductsPayload']: AliasType<{
/** The asynchronous job removing the products. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `collectionReorderProducts` mutation. */
['CollectionReorderProductsPayload']: AliasType<{
/** The asynchronous job reordering the products. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents at rule that's used to assign products to a collection. */
['CollectionRule']: AliasType<{
/** The attribute that the rule focuses on (for example, `title` or `product_type`). */
column?: boolean;
/** The value that the operator is applied to (for example, `Hats`). */
condition?: boolean;
/** The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`). */
relation?: boolean;
__typename?: boolean;
}>;
/** Specifies the property of a product being used to populate the smart collection. */
['CollectionRuleColumn']: CollectionRuleColumn;
/** Collections may use rules to automatically include the matching products. This defines restrictions for a type of rule. */
['CollectionRuleConditions']: AliasType<{
/** Allowed relations of the rule. */
allowedRelations?: boolean;
/** Most commonly used relation for this rule. */
defaultRelation?: boolean;
/** Type of the rule. */
ruleType?: boolean;
__typename?: boolean;
}>;
/** Specifies a rule to associate with a collection. */
['CollectionRuleInput']: {
/** The attribute that the rule focuses on (for example, `title` or `product_type`). */
column: ValueTypes['CollectionRuleColumn'];
/** The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`). */
relation: ValueTypes['CollectionRuleRelation'];
/** The value that the operator is applied to (for example, `Hats`). */
condition: string;
};
/** Specifies the relationship between the `column` and the condition. */
['CollectionRuleRelation']: CollectionRuleRelation;
/** The set of rules that are used to determine which products are included in the collection. */
['CollectionRuleSet']: AliasType<{
/** Whether products must match any or all of the rules to be included in the collection.
If true, then products must match one or more of the rules to be included in the collection.
If false, then products must match all of the rules to be included in the collection. */
appliedDisjunctively?: boolean;
/** The rules used to assign products to the collection. */
rules?: ValueTypes['CollectionRule'];
__typename?: boolean;
}>;
/** Specifies a rule set for the collection. */
['CollectionRuleSetInput']: {
/** Whether products must match any or all of the rules to be included in the collection.
If true, then products must match one or more of the rules to be included in the collection.
If false, then products must match all of the rules to be included in the collection. */
appliedDisjunctively: boolean;
/** The rules used to assign products to the collection. */
rules?: ValueTypes['CollectionRuleInput'][];
};
/** The set of valid sort keys for the Collection query. */
['CollectionSortKeys']: CollectionSortKeys;
/** Specifies the sort order for the products in the collection. */
['CollectionSortOrder']: CollectionSortOrder;
/** Specifies the collection to unpublish and the sales channels to remove it from. */
['CollectionUnpublishInput']: {
/** The collection to create or update publications for. */
id: string;
/** The channels where the collection is published. */
collectionPublications: ValueTypes['CollectionPublicationInput'][];
};
/** Return type for `collectionUnpublish` mutation. */
['CollectionUnpublishPayload']: AliasType<{
/** The collection that has been unpublished. */
collection?: ValueTypes['Collection'];
/** The shop associated with the collection. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `collectionUpdate` mutation. */
['CollectionUpdatePayload']: AliasType<{
/** The updated collection. */
collection?: ValueTypes['Collection'];
/** The asynchronous job updating the products based on the new rule set. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Comment events are generated by staff members of a shop.
They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer. */
['CommentEvent']: AliasType<{
/** The name of the app that created the event. */
appTitle?: boolean;
/** The attachments associated with the comment event. */
attachments?: ValueTypes['CommentEventAttachment'];
/** Whether the event was created by an app. */
attributeToApp?: boolean;
/** Whether the event was caused by an admin user. */
attributeToUser?: boolean;
/** Whether the comment event can be deleted. If true, then the comment event can be deleted. */
canDelete?: boolean;
/** Whether the comment event can be edited. If true, then the comment event can be edited. */
canEdit?: boolean;
/** The date and time when the event was created. */
createdAt?: boolean;
/** Whether the event is critical. */
criticalAlert?: boolean;
/** Whether the comment event has been edited. If true, then the comment event has been edited. */
edited?: boolean;
/** The object reference associated with the comment event. For example, a product or discount). */
embed?: ValueTypes['CommentEventEmbed'];
/** A globally-unique identifier. */
id?: boolean;
/** Human readable text that describes the event. */
message?: boolean;
/** The raw body of the comment event. */
rawMessage?: boolean;
/** The parent subject to which the comment event belongs. */
subject?: ValueTypes['CommentEventSubject'];
__typename?: boolean;
}>;
/** A file attachment associated to a comment event. */
['CommentEventAttachment']: AliasType<{
/** The file extension of the comment event attachment, indicating the file format. */
fileExtension?: boolean;
/** A globally-unique identifier. */
id?: boolean;
image?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** The filename of the comment event attachment. */
name?: boolean;
/** The size of the attachment. */
size?: boolean;
/** The URL of the attachment. */
url?: boolean;
__typename?: boolean;
}>;
/** The main embed of a comment event. */
['CommentEventEmbed']: AliasType<{
['...on Customer']: ValueTypes['Customer'];
['...on DraftOrder']: ValueTypes['DraftOrder'];
['...on Order']: ValueTypes['Order'];
['...on Product']: ValueTypes['Product'];
['...on ProductVariant']: ValueTypes['ProductVariant'];
__typename?: boolean;
}>;
/** The subject line of a comment event. */
['CommentEventSubject']: AliasType<{
/** Whether the timeline subject has a timeline comment. If true, then a timeline comment exists. */
hasTimelineComment?: boolean;
/** A globally-unique identifier. */
id?: boolean;
['...on Customer']?: Omit<ValueTypes['Customer'], keyof ValueTypes['CommentEventSubject']>;
['...on DraftOrder']?: Omit<ValueTypes['DraftOrder'], keyof ValueTypes['CommentEventSubject']>;
['...on Order']?: Omit<ValueTypes['Order'], keyof ValueTypes['CommentEventSubject']>;
['...on PriceRule']?: Omit<ValueTypes['PriceRule'], keyof ValueTypes['CommentEventSubject']>;
__typename?: boolean;
}>;
/** The context data that determines the pricing of a variant. */
['ContextualPricingContext']: {
/** The country code used to fetch country-specific prices. */
country?: ValueTypes['CountryCode'] | null;
};
/** The list of all the countries from the combined shipping zones for the shop. */
['CountriesInShippingZones']: AliasType<{
/** The list of all the countries from all the combined shipping zones. */
countryCodes?: boolean;
/** Whether 'Rest of World' has been defined in any of the shipping zones. */
includeRestOfWorld?: boolean;
__typename?: boolean;
}>;
/** ISO 3166-1 alpha-2 country codes with some differences. */
['CountryCode']: CountryCode;
/** The country-specific harmonized system code and ISO country code for an inventory item. */
['CountryHarmonizedSystemCode']: AliasType<{
/** The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. */
countryCode?: boolean;
/** The country-specific harmonized system code. These are usually longer than 6 digits. */
harmonizedSystemCode?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple CountryHarmonizedSystemCodes. */
['CountryHarmonizedSystemCodeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CountryHarmonizedSystemCodeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one CountryHarmonizedSystemCode and a cursor during pagination. */
['CountryHarmonizedSystemCodeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CountryHarmonizedSystemCodeEdge. */
node?: ValueTypes['CountryHarmonizedSystemCode'];
__typename?: boolean;
}>;
/** The fields required to specify a harmonized system code. */
['CountryHarmonizedSystemCodeInput']: {
/** Country specific harmonized system code. */
harmonizedSystemCode: string;
/** The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. */
countryCode: ValueTypes['CountryCode'];
};
/** Specifies the input fields required to create a media object. */
['CreateMediaInput']: {
/** The original source of the media object. May be an external URL or signed upload URL. */
originalSource: string;
/** The alt text associated to the media. */
alt?: string | null;
/** The media content type. */
mediaContentType: ValueTypes['MediaContentType'];
};
/** The part of the image that should remain after cropping. */
['CropRegion']: CropRegion;
/** The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes,
and non-standard codes. */
['CurrencyCode']: CurrencyCode;
/** Currency formats configured for the merchant. These formats are available to use within Liquid. */
['CurrencyFormats']: AliasType<{
/** Money without currency in HTML. */
moneyFormat?: boolean;
/** Money without currency in emails. */
moneyInEmailsFormat?: boolean;
/** Money with currency in HTML. */
moneyWithCurrencyFormat?: boolean;
/** Money with currency in emails. */
moneyWithCurrencyInEmailsFormat?: boolean;
__typename?: boolean;
}>;
/** A setting for a presentment currency. */
['CurrencySetting']: AliasType<{
/** The currency's ISO code. */
currencyCode?: boolean;
/** The full name of the currency. */
currencyName?: boolean;
/** Whether the currency is enabled or not. An enabled currency setting is visible to buyers and allows orders to be generated with that currency as presentment. */
enabled?: boolean;
/** The date and time when the active exchange rate for the currency was last modified. It can be the automatic rate's creation date, or the manual rate's last updated at date if active. */
rateUpdatedAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple CurrencySettings. */
['CurrencySettingConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CurrencySettingEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one CurrencySetting and a cursor during pagination. */
['CurrencySettingEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CurrencySettingEdge. */
node?: ValueTypes['CurrencySetting'];
__typename?: boolean;
}>;
/** Represents information about a customer of the shop, such as the customer's contact details, their order
history, and whether they've agreed to receive marketing material by email.
**Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. */
['Customer']: AliasType<{
/** Whether the customer has agreed to receive marketing material. */
acceptsMarketing?: boolean;
/** The date and time when the customer consented or objected to receiving marketing material by email. */
acceptsMarketingUpdatedAt?: boolean;
addresses?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['MailingAddress']
];
/** The average amount that the customer spent per order. */
averageOrderAmount?: boolean;
/** The average amount that the customer spent per order. */
averageOrderAmountV2?: ValueTypes['MoneyV2'];
/** Whether the merchant can delete the customer from their store.
A customer can be deleted from a store only if they have not yet made an order. After a customer makes an
order, they can't be deleted from a store. */
canDelete?: boolean;
/** The date and time when the customer was added to the store. */
createdAt?: boolean;
/** The default address associated with the customer. */
defaultAddress?: ValueTypes['MailingAddress'];
/** The full name of the customer, based on the values for first_name and last_name. If the first_name and
last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. */
displayName?: boolean;
/** The customer's email address. */
email?: boolean;
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
/** The customer's first name. */
firstName?: boolean;
/** Whether the customer has a note associated with them. */
hasNote?: boolean;
/** Whether the merchant has added timeline comments about the customer on the customer's page. */
hasTimelineComment?: boolean;
/** A globally-unique identifier. */
id?: boolean;
image?: [
{
/** Image width and height (1 - 2048 pixels) This argument is deprecated: Use `maxWidth` or `maxHeight` on `Image.transformedSrc` instead. */
size?: number | null;
},
ValueTypes['Image']
];
/** The customer's last name. */
lastName?: boolean;
/** The customer's last order. */
lastOrder?: ValueTypes['Order'];
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The amount of time since the customer was first added to the store.
Example: 'about 12 years'. */
lifetimeDuration?: boolean;
/** The customer's locale. */
locale?: boolean;
/** The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the
customer gave when they consented to receive marketing material by email.
If the customer does not accept email marketing, then this property is `null`. */
marketingOptInLevel?: boolean;
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafieldDefinitions?: [
{
/** Filter metafield definitions by namespace. */
namespace?: string | null /** Filter by the definition's pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
/** A unique identifier for the customer that's used with Multipass login. */
multipassIdentifier?: boolean;
/** A note about the customer. */
note?: boolean;
orders?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['OrderSortKeys'] | null /** Supported filter parameters:
- `cart_token`
- `channel`
- `channel_id`
- `chargeback_status`
- `checkout_token`
- `created_at`
- `credit_card_last4`
- `customer_id`
- `delivery_method`
- `discount_code`
- `earliest_fulfill_by`
- `email`
- `financial_status`
- `fraud_protection_level`
- `fulfillment_location_id`
- `fulfillment_status`
- `gateway`
- `location_id`
- `name`
- `payment_provider_id`
- `processed_at`
- `reference_location_id`
- `return_status`
- `risk_level`
- `sales_channel`
- `source_identifier`
- `source_name`
- `status`
- `tag`
- `tag_not`
- `test`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['OrderConnection']
];
/** The number of orders that the customer has made at the store in their lifetime. */
ordersCount?: boolean;
paymentMethods?: [
{
/** Whether to show the customer's revoked payment method. */
showRevoked?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CustomerPaymentMethodConnection']
];
/** The customer's phone number. */
phone?: boolean;
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
/** Possible subscriber states of a customer defined by their subscription contracts. */
productSubscriberStatus?: boolean;
/** The current SMS marketing state for the customer's phone number.
If the customer does not have a phone number, then this property is `null`. */
smsMarketingConsent?: ValueTypes['CustomerSmsMarketingConsentState'];
/** The state of the customer's account with the shop. */
state?: boolean;
subscriptionContracts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionContractConnection']
];
/** A comma separated list of tags that have been added to the customer. */
tags?: boolean;
/** Whether the customer is exempt from being charged taxes on their orders. */
taxExempt?: boolean;
/** The list of tax exemptions applied to the customer. */
taxExemptions?: boolean;
/** The total amount that the customer has spent on orders in their lifetime. */
totalSpent?: boolean;
/** The total amount that the customer has spent on orders in their lifetime. */
totalSpentV2?: ValueTypes['MoneyV2'];
/** The date and time when the customer was last updated. */
updatedAt?: boolean;
/** Whether the email address is formatted correctly. This does not
guarantee that the email address actually exists. */
validEmailAddress?: boolean;
/** Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API. */
verifiedEmail?: boolean;
__typename?: boolean;
}>;
/** Return type for `customerAddTaxExemptions` mutation. */
['CustomerAddTaxExemptionsPayload']: AliasType<{
/** The updated customer. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Customers. */
['CustomerConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CustomerEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** The source that collected the customer's consent to receive marketing materials. */
['CustomerConsentCollectedFrom']: CustomerConsentCollectedFrom;
/** Return type for `customerCreate` mutation. */
['CustomerCreatePayload']: AliasType<{
/** The created customer. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents a card instrument for customer payment method. */
['CustomerCreditCard']: AliasType<{
/** The billing address of the card. */
billingAddress?: ValueTypes['CustomerCreditCardBillingAddress'];
/** The brand of the card. */
brand?: boolean;
/** Whether the card is about to expire. */
expiresSoon?: boolean;
/** The expiry month of the card. */
expiryMonth?: boolean;
/** The expiry year of the card. */
expiryYear?: boolean;
/** The card's BIN number. */
firstDigits?: boolean;
/** The payment method can be revoked if there are no active subscription contracts. */
isRevocable?: boolean;
/** The last 4 digits of the card. */
lastDigits?: boolean;
/** The masked card number with only the last 4 digits displayed. */
maskedNumber?: boolean;
/** The name of the card holder. */
name?: boolean;
/** The source of the card if coming from a wallet such as Apple Pay. */
source?: boolean;
/** The last 4 digits of the Device Account Number. */
virtualLastDigits?: boolean;
__typename?: boolean;
}>;
/** The billing address of a credit card payment instrument. */
['CustomerCreditCardBillingAddress']: AliasType<{
/** The first line of the address. Typically the street address or PO Box number. */
address1?: boolean;
/** The name of the city, district, village, or town. */
city?: boolean;
/** The name of the country. */
country?: boolean;
/** The two-letter code for the country of the address.
For example, US. */
countryCode?: boolean;
/** The region of the address, such as the province, state, or district. */
province?: boolean;
/** The two-letter code for the region.
For example, ON. */
provinceCode?: boolean;
/** The zip or postal code of the address. */
zip?: boolean;
__typename?: boolean;
}>;
/** Specifies the customer to delete. */
['CustomerDeleteInput']: {
/** The ID of the customer to delete. */
id: string;
};
/** Return type for `customerDelete` mutation. */
['CustomerDeletePayload']: AliasType<{
/** The ID of the deleted customer. */
deletedCustomerId?: boolean;
/** The shop of the deleted customer. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Customer and a cursor during pagination. */
['CustomerEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CustomerEdge. */
node?: ValueTypes['Customer'];
__typename?: boolean;
}>;
/** Return type for `customerGenerateAccountActivationUrl` mutation. */
['CustomerGenerateAccountActivationUrlPayload']: AliasType<{
/** The generated account activation URL. */
accountActivationUrl?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Provides the fields and values to use when creating or updating a customer. */
['CustomerInput']: {
/** Whether the customer has consented to receive marketing material by email. This argument is deprecated: Use `emailMarketingConsent` instead in API versions 2022-04 and higher. */
acceptsMarketing?: boolean | null;
/** The date and time when the customer consented or objected to receiving marketing
material by email.
This argument is deprecated: Use `emailMarketingConsent` instead in API versions 2022-04 and higher. */
acceptsMarketingUpdatedAt?: ValueTypes['DateTime'] | null;
/** The addresses for a customer. */
addresses?: ValueTypes['MailingAddressInput'][];
/** The unique email address of the customer. */
email?: string | null;
/** The customer's first name. */
firstName?: string | null;
/** The ID of the customer to update. */
id?: string | null;
/** The customer's last name. */
lastName?: string | null;
/** The customer's locale. */
locale?: string | null;
/** The marketing subscription opt-in level used when the customer consented to receiving
marketing material by email.
This argument is deprecated: Use `emailMarketingConsent` instead in API versions 2022-04 and higher. */
marketingOptInLevel?: ValueTypes['CustomerMarketingOptInLevel'] | null;
/** Additional metafields to associate to the customer. */
metafields?: ValueTypes['MetafieldInput'][];
/** A note about the customer. */
note?: string | null;
/** The unique phone number for the customer. */
phone?: string | null;
/** The private metafields to associate with the customer. */
privateMetafields?: ValueTypes['PrivateMetafieldInput'][];
/** A list of tags to associate with the customer. Can be an array or a comma-separated list. Example values: `["tag1", "tag2", "tag3"]`, `"tag1, tag2, tag3"`
Updating `tags` overwrites any existing tags that were previously added to the customer. To add new tags without overwriting
existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)
mutation. */
tags?: string[];
/** The marketing consent information when the customer consented to receiving marketing
material by SMS. The `phone` field is required when creating a customer with SMS
marketing consent information. */
smsMarketingConsent?: ValueTypes['CustomerSmsMarketingConsentInput'] | null;
/** Whether the customer is exempt from paying taxes on their order. */
taxExempt?: boolean | null;
/** The list of tax exemptions to apply to the customer. */
taxExemptions?: ValueTypes['TaxExemption'][];
};
/** Represents a customer's visiting activities on a shop's online store. */
['CustomerJourney']: AliasType<{
/** The position of the current order within the customer's order history. */
customerOrderIndex?: boolean;
/** The amount of days between first session and order creation date. First session represents first session since the last order, or first session within the 30 day attribution window, if more than 30 days has passed since the last order. */
daysToConversion?: boolean;
/** The customer's first session going into the shop. */
firstVisit?: ValueTypes['CustomerVisit'];
/** The last session before an order is made. */
lastVisit?: ValueTypes['CustomerVisit'];
/** Events preceding a customer order, such as shop sessions. */
moments?: ValueTypes['CustomerMoment'];
__typename?: boolean;
}>;
/** Represents a customer's visiting activities on a shop's online store. */
['CustomerJourneySummary']: AliasType<{
/** The position of the current order within the customer's order history. Test orders aren't included. */
customerOrderIndex?: boolean;
/** The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order. */
daysToConversion?: boolean;
/** The customer's first session going into the shop. */
firstVisit?: ValueTypes['CustomerVisit'];
/** The last session before an order is made. */
lastVisit?: ValueTypes['CustomerVisit'];
moments?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CustomerMomentConnection']
];
/** The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed. */
momentsCount?: boolean;
/** Whether or not the attributed sessions for the order have been created yet. */
ready?: boolean;
__typename?: boolean;
}>;
/** The possible values for the marketing subscription opt in level enabled at the time the customer consented to receive marketing information.
The levels are defined by [the M3AAWG best practices guideline
document](https://www.m3aawg.org/sites/maawg/files/news/M3AAWG_Senders_BCP_Ver3-2015-02.pdf). */
['CustomerMarketingOptInLevel']: CustomerMarketingOptInLevel;
/** Represents a session preceding an order, often used for building a timeline of events leading to an order. */
['CustomerMoment']: AliasType<{
/** The date and time when the customer's session occurred. */
occurredAt?: boolean;
['...on CustomerVisit']?: Omit<ValueTypes['CustomerVisit'], keyof ValueTypes['CustomerMoment']>;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple CustomerMoments. */
['CustomerMomentConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CustomerMomentEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one CustomerMoment and a cursor during pagination. */
['CustomerMomentEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CustomerMomentEdge. */
node?: ValueTypes['CustomerMoment'];
__typename?: boolean;
}>;
/** All possible instruments for CustomerPaymentMethods. */
['CustomerPaymentInstrument']: AliasType<{
['...on CustomerCreditCard']: ValueTypes['CustomerCreditCard'];
['...on CustomerPaypalBillingAgreement']: ValueTypes['CustomerPaypalBillingAgreement'];
['...on CustomerShopPayAgreement']: ValueTypes['CustomerShopPayAgreement'];
__typename?: boolean;
}>;
/** The billing address of a payment instrument. */
['CustomerPaymentInstrumentBillingAddress']: AliasType<{
/** The first line of the address. Typically the street address or PO Box number. */
address1?: boolean;
/** The name of the city, district, village, or town. */
city?: boolean;
/** The name of the country. */
country?: boolean;
/** The two-letter code for the country of the address.
For example, US. */
countryCode?: boolean;
/** The name of the buyer of the address. */
name?: boolean;
/** The region of the address, such as the province, state, or district. */
province?: boolean;
/** The two-letter code for the region.
For example, ON. */
provinceCode?: boolean;
/** The zip or postal code of the address. */
zip?: boolean;
__typename?: boolean;
}>;
/** A customer's payment method. */
['CustomerPaymentMethod']: AliasType<{
/** The customer to whom the payment method belongs. */
customer?: ValueTypes['Customer'];
/** The ID of this payment method. */
id?: boolean;
/** The instrument for this payment method. */
instrument?: ValueTypes['CustomerPaymentInstrument'];
/** The time that the payment method was revoked. */
revokedAt?: boolean;
/** The revocation reason for this payment method. */
revokedReason?: boolean;
subscriptionContracts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionContractConnection']
];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple CustomerPaymentMethods. */
['CustomerPaymentMethodConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['CustomerPaymentMethodEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `customerPaymentMethodCreditCardCreate` mutation. */
['CustomerPaymentMethodCreditCardCreatePayload']: AliasType<{
/** The customer payment method. */
customerPaymentMethod?: ValueTypes['CustomerPaymentMethod'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `customerPaymentMethodCreditCardUpdate` mutation. */
['CustomerPaymentMethodCreditCardUpdatePayload']: AliasType<{
/** The customer payment method. */
customerPaymentMethod?: ValueTypes['CustomerPaymentMethod'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination. */
['CustomerPaymentMethodEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of CustomerPaymentMethodEdge. */
node?: ValueTypes['CustomerPaymentMethod'];
__typename?: boolean;
}>;
/** Return type for `customerPaymentMethodGetUpdateUrl` mutation. */
['CustomerPaymentMethodGetUpdateUrlPayload']: AliasType<{
/** The URL to redirect the customer to update the payment method. */
updatePaymentMethodUrl?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['CustomerPaymentMethodGetUpdateUrlUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `CustomerPaymentMethodGetUpdateUrl`. */
['CustomerPaymentMethodGetUpdateUrlUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `CustomerPaymentMethodGetUpdateUrlUserError`. */
['CustomerPaymentMethodGetUpdateUrlUserErrorCode']: CustomerPaymentMethodGetUpdateUrlUserErrorCode;
/** Return type for `customerPaymentMethodPaypalBillingAgreementCreate` mutation. */
['CustomerPaymentMethodPaypalBillingAgreementCreatePayload']: AliasType<{
/** The customer payment method. */
customerPaymentMethod?: ValueTypes['CustomerPaymentMethod'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['CustomerPaymentMethodUserError'];
__typename?: boolean;
}>;
/** Return type for `customerPaymentMethodPaypalBillingAgreementUpdate` mutation. */
['CustomerPaymentMethodPaypalBillingAgreementUpdatePayload']: AliasType<{
/** The customer payment method. */
customerPaymentMethod?: ValueTypes['CustomerPaymentMethod'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['CustomerPaymentMethodUserError'];
__typename?: boolean;
}>;
/** Return type for `customerPaymentMethodRemoteCreate` mutation. */
['CustomerPaymentMethodRemoteCreatePayload']: AliasType<{
/** The customer payment method. */
customerPaymentMethod?: ValueTypes['CustomerPaymentMethod'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['CustomerPaymentMethodRemoteUserError'];
__typename?: boolean;
}>;
/** Return type for `customerPaymentMethodRemoteCreditCardCreate` mutation. */
['CustomerPaymentMethodRemoteCreditCardCreatePayload']: AliasType<{
/** The customer payment method. */
customerPaymentMethod?: ValueTypes['CustomerPaymentMethod'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['CustomerPaymentMethodUserError'];
__typename?: boolean;
}>;
/** Input for a remote gateway payment method, only one remote reference permitted. */
['CustomerPaymentMethodRemoteInput']: {
/** Input containing the fields for a remote stripe payment method. */
stripePaymentMethod?: ValueTypes['RemoteStripePaymentMethodInput'] | null;
/** Input containing the fields for a remote authorize net customer profile. */
authorizeNetCustomerPaymentProfile?: ValueTypes['RemoteAuthorizeNetCustomerPaymentProfileInput'] | null;
};
/** Represents an error in the input of a mutation. */
['CustomerPaymentMethodRemoteUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `CustomerPaymentMethodRemoteUserError`. */
['CustomerPaymentMethodRemoteUserErrorCode']: CustomerPaymentMethodRemoteUserErrorCode;
/** The revocation reason types for a customer payment method. */
['CustomerPaymentMethodRevocationReason']: CustomerPaymentMethodRevocationReason;
/** Return type for `customerPaymentMethodRevoke` mutation. */
['CustomerPaymentMethodRevokePayload']: AliasType<{
/** The ID of the revoked customer payment method. */
revokedCustomerPaymentMethodId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `customerPaymentMethodSendUpdateEmail` mutation. */
['CustomerPaymentMethodSendUpdateEmailPayload']: AliasType<{
/** The customer to whom an update payment method email was sent. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents an error in the input of a mutation. */
['CustomerPaymentMethodUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `CustomerPaymentMethodUserError`. */
['CustomerPaymentMethodUserErrorCode']: CustomerPaymentMethodUserErrorCode;
/** Represents a PayPal instrument for customer payment method. */
['CustomerPaypalBillingAgreement']: AliasType<{
/** The billing address of this payment method. */
billingAddress?: ValueTypes['CustomerPaymentInstrumentBillingAddress'];
/** Whether the PayPal billing agreement is inactive. */
inactive?: boolean;
/** Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts. */
isRevocable?: boolean;
/** The customers's PayPal account email address. */
paypalAccountEmail?: boolean;
__typename?: boolean;
}>;
/** The possible product subscription states for a customer, as defined by the customer's subscription contracts. */
['CustomerProductSubscriberStatus']: CustomerProductSubscriberStatus;
/** Return type for `customerRemoveTaxExemptions` mutation. */
['CustomerRemoveTaxExemptionsPayload']: AliasType<{
/** The updated customer. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `customerReplaceTaxExemptions` mutation. */
['CustomerReplaceTaxExemptionsPayload']: AliasType<{
/** The updated customer. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the CustomerSavedSearch query. */
['CustomerSavedSearchSortKeys']: CustomerSavedSearchSortKeys;
/** Represents a Shop Pay card instrument for customer payment method. */
['CustomerShopPayAgreement']: AliasType<{
/** Whether the card is about to expire. */
expiresSoon?: boolean;
/** The expiry month of the card. */
expiryMonth?: boolean;
/** The expiry year of the card. */
expiryYear?: boolean;
/** Whether the Shop Pay billing agreement is inactive. */
inactive?: boolean;
/** The payment method can be revoked if there are no active subscription contracts. */
isRevocable?: boolean;
/** The last 4 digits of the card. */
lastDigits?: boolean;
/** The masked card number with only the last 4 digits displayed. */
maskedNumber?: boolean;
/** The name of the card holder. */
name?: boolean;
__typename?: boolean;
}>;
/** An error that occurs during execution of an SMS marketing consent mutation. */
['CustomerSmsMarketingConsentError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `CustomerSmsMarketingConsentError`. */
['CustomerSmsMarketingConsentErrorCode']: CustomerSmsMarketingConsentErrorCode;
/** The marketing consent information when the customer consented to
receiving marketing material by SMS. */
['CustomerSmsMarketingConsentInput']: {
/** The marketing subscription opt in level set when the customer consented to receive marketing information. */
marketingOptInLevel?: ValueTypes['CustomerMarketingOptInLevel'] | null;
/** The current SMS marketing state for the customer. */
marketingState: ValueTypes['CustomerSmsMarketingState'];
/** The date and time when the customer consented to receive marketing material by SMS.
If no date is provided, then the date and time when the consent information was sent is used. */
consentUpdatedAt?: ValueTypes['DateTime'] | null;
};
/** The record of when a customer consented to receive marketing material by SMS.
The customer's consent state reflects the record with the most recent date when consent was updated. */
['CustomerSmsMarketingConsentState']: AliasType<{
/** The source from which the SMS marketing information for the customer was collected. */
consentCollectedFrom?: boolean;
/** The date and time when the customer consented to receive marketing material by SMS.
If no date is provided, then the date and time when the consent information was sent is used. */
consentUpdatedAt?: boolean;
/** The marketing subscription opt in level set when the customer consented to receive marketing information. */
marketingOptInLevel?: boolean;
/** The current SMS marketing state for the customer. */
marketingState?: boolean;
__typename?: boolean;
}>;
/** The SMS marketing consent information to update for a given customer ID. */
['CustomerSmsMarketingConsentUpdateInput']: {
/** The ID of the customer to update the SMS marketing consent information for. The customer must have a unique phone number associated to the record. If not, add the phone number using the `customerUpdate` mutation first. */
customerId: string;
/** The marketing consent information when the customer consented to receiving marketing material by SMS. */
smsMarketingConsent: ValueTypes['CustomerSmsMarketingConsentInput'];
};
/** Return type for `customerSmsMarketingConsentUpdate` mutation. */
['CustomerSmsMarketingConsentUpdatePayload']: AliasType<{
/** The updated customer. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['CustomerSmsMarketingConsentError'];
__typename?: boolean;
}>;
/** The valid SMS marketing states for a customer’s phone number. */
['CustomerSmsMarketingState']: CustomerSmsMarketingState;
/** The set of valid sort keys for the Customer query. */
['CustomerSortKeys']: CustomerSortKeys;
/** The valid values for the state of a customer's account with a shop. */
['CustomerState']: CustomerState;
/** Return type for `customerUpdateDefaultAddress` mutation. */
['CustomerUpdateDefaultAddressPayload']: AliasType<{
/** The customer whose address was updated. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `customerUpdate` mutation. */
['CustomerUpdatePayload']: AliasType<{
/** The updated customer. */
customer?: ValueTypes['Customer'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session. */
['CustomerVisit']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** URL of the first page the customer landed on for the session. */
landingPage?: boolean;
/** Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1. */
landingPageHtml?: boolean;
/** Represent actions taken by an app, on behalf of a merchant,
to market Shopify resources such as products, collections, and discounts. */
marketingEvent?: ValueTypes['MarketingEvent'];
/** The date and time when the customer's session occurred. */
occurredAt?: boolean;
/** Marketing referral code from the link that the customer clicked to visit the store.
Supports the following URL attributes: _ref_, _source_, or _r_.
For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. */
referralCode?: boolean;
/** Referral information with URLs linked in HTML. */
referralInfoHtml?: boolean;
/** Webpage where the customer clicked a link that sent them to the online store.
For example, _https://randomblog.com/page1_ or _android-app://com.google.android.gm_. */
referrerUrl?: boolean;
/** Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct,
a website domain, QR code, or unknown. */
source?: boolean;
/** Describes the source explicitly for first or last session. */
sourceDescription?: boolean;
/** Type of marketing tactic. */
sourceType?: boolean;
/** A set of UTM parameters gathered from the URL parameters of the referrer. */
utmParameters?: ValueTypes['UTMParameters'];
__typename?: boolean;
}>;
/** Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date string.
For example, September 7, 2019 is represented as `"2019-07-16"`. */
['Date']: unknown;
/** Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string.
For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is
represented as `"2019-09-07T15:50:00Z`". */
['DateTime']: unknown;
/** Days of the week from Monday to Sunday. */
['DayOfTheWeek']: DayOfTheWeek;
/** A signed decimal number, which supports arbitrary precision and is serialized as a string.
Example values: `"29.99"`, `"29.999"`. */
['Decimal']: unknown;
/** Deletion events chronicle the destruction of resources (e.g. products and collections).
Once deleted, the deletion event is the only trace of the original's existence,
as the resource itself has been removed and can no longer be accessed. */
['DeletionEvent']: AliasType<{
/** The date and time when the deletion event for the related resource was generated. */
occurredAt?: boolean;
/** The id of the resource that was deleted. */
subjectId?: boolean;
/** The type of resource that was deleted. */
subjectType?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DeletionEvents. */
['DeletionEventConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DeletionEventEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DeletionEvent and a cursor during pagination. */
['DeletionEventEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DeletionEventEdge. */
node?: ValueTypes['DeletionEvent'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the DeletionEvent query. */
['DeletionEventSortKeys']: DeletionEventSortKeys;
/** The supported subject types of deletion events. */
['DeletionEventSubjectType']: DeletionEventSubjectType;
/** A shipping service and a list of countries that the service is available for. */
['DeliveryAvailableService']: AliasType<{
/** The countries the service provider ships to. */
countries?: ValueTypes['DeliveryCountryCodesOrRestOfWorld'];
/** The name of the service. */
name?: boolean;
__typename?: boolean;
}>;
/** A shipping service provider or a carrier account. */
['DeliveryCarrierService']: AliasType<{
availableServicesForCountries?: [
{
/** The locations of the possible origins. */
origins?: string[] /** The country codes of the destinations. */;
countryCodes?: ValueTypes['CountryCode'][] /** Whether to use 'Rest of World' as the destination. */;
restOfWorld: boolean;
},
ValueTypes['DeliveryAvailableService']
];
/** The properly formatted name of the shipping service provider, ready to display. */
formattedName?: boolean;
/** The logo of the service provider. */
icon?: ValueTypes['Image'];
/** A globally-unique identifier. */
id?: boolean;
/** The name of the shipping service provider. */
name?: boolean;
__typename?: boolean;
}>;
/** A carrier service and the associated list of shop locations. */
['DeliveryCarrierServiceAndLocations']: AliasType<{
/** The carrier service. */
carrierService?: ValueTypes['DeliveryCarrierService'];
/** The list of locations that support this carrier service. */
locations?: ValueTypes['Location'];
__typename?: boolean;
}>;
/** A condition that must pass for a delivery method definition to be applied to an order. */
['DeliveryCondition']: AliasType<{
/** The value (weight or price) that the condition field is compared to. */
conditionCriteria?: ValueTypes['DeliveryConditionCriteria'];
/** The field to compare the criterion value against, using the operator. */
field?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The operator to compare the field and criterion value. */
operator?: boolean;
__typename?: boolean;
}>;
/** The value (weight or price) that the condition field is compared to. */
['DeliveryConditionCriteria']: AliasType<{
['...on MoneyV2']: ValueTypes['MoneyV2'];
['...on Weight']: ValueTypes['Weight'];
__typename?: boolean;
}>;
/** The field type that the condition will be applied to. */
['DeliveryConditionField']: DeliveryConditionField;
/** The operator to use to determine if the condition passes. */
['DeliveryConditionOperator']: DeliveryConditionOperator;
/** A country that is used to define a shipping zone. */
['DeliveryCountry']: AliasType<{
/** A two-letter country code in ISO 3166-1 alpha-2 standard.
It also includes a flag indicating whether the country should be
a part of the 'Rest Of World' shipping zone. */
code?: ValueTypes['DeliveryCountryCodeOrRestOfWorld'];
/** A globally-unique identifier. */
id?: boolean;
/** The full name of the country. */
name?: boolean;
/** The list of regions associated with this country. */
provinces?: ValueTypes['DeliveryProvince'];
/** The translated name of the country. The translation returned is based on the system's locale. */
translatedName?: boolean;
__typename?: boolean;
}>;
/** The country details and the associated shipping zone. */
['DeliveryCountryAndZone']: AliasType<{
/** The country details. */
country?: ValueTypes['DeliveryCountry'];
/** The name of the shipping zone. */
zone?: boolean;
__typename?: boolean;
}>;
/** The country code and whether the country is a part of the 'Rest Of World' shipping zone. */
['DeliveryCountryCodeOrRestOfWorld']: AliasType<{
/** The country code in the ISO 3166-1 alpha-2 format. */
countryCode?: boolean;
/** Whether the country is a part of the 'Rest of World' shipping zone. */
restOfWorld?: boolean;
__typename?: boolean;
}>;
/** The list of country codes and information whether the countries
are a part of the 'Rest Of World' shipping zone. */
['DeliveryCountryCodesOrRestOfWorld']: AliasType<{
/** List of applicable country codes in the ISO 3166-1 alpha-2 format. */
countryCodes?: boolean;
/** Whether the countries are a part of the 'Rest of World' shipping zone. */
restOfWorld?: boolean;
__typename?: boolean;
}>;
/** Input fields to specify a country. */
['DeliveryCountryInput']: {
/** The country code of the country in the ISO 3166-1 alpha-2 format. */
code?: ValueTypes['CountryCode'] | null;
/** Whether the country is a part of the 'Rest of World' shipping zone. */
restOfWorld?: boolean | null;
/** The regions associated with this country. */
provinces?: ValueTypes['DeliveryProvinceInput'][];
/** Associate all available provinces with this country. */
includeAllProvinces?: boolean | null;
};
/** Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned. */
['DeliveryLegacyModeBlocked']: AliasType<{
/** Whether the shop can convert to full multi-location delivery profiles mode. */
blocked?: boolean;
/** The reasons why the shop is blocked from converting to full multi-location delivery profiles mode. */
reasons?: boolean;
__typename?: boolean;
}>;
/** Reasons the shop is blocked from converting to full multi-location delivery profiles mode. */
['DeliveryLegacyModeBlockedReason']: DeliveryLegacyModeBlockedReason;
/** A location group is a collection of active locations. They share zones and delivery methods across delivery
profiles. */
['DeliveryLocationGroup']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
locations?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['LocationSortKeys'] | null /** Supported filter parameters:
- `active`
- `address1`
- `address2`
- `city`
- `country`
- `legacy`
- `name`
- `province`
- `zip`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** If true, also include the legacy locations of fulfillment services. */;
includeLegacy?: boolean | null /** If true, also include the locations that are deactivated. */;
includeInactive?: boolean | null;
},
ValueTypes['LocationConnection']
];
__typename?: boolean;
}>;
/** Links a location group with a zone and the associated method definitions. */
['DeliveryLocationGroupZone']: AliasType<{
/** The number of method definitions for the zone. */
methodDefinitionCounts?: ValueTypes['DeliveryMethodDefinitionCounts'];
methodDefinitions?: [
{
/** Return only eligible or ineligible method definitions. */
eligible?: boolean | null /** Return only merchant or participant method definitions. */;
type?: ValueTypes['DeliveryMethodDefinitionType'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MethodDefinitionSortKeys'] | null;
},
ValueTypes['DeliveryMethodDefinitionConnection']
];
/** The zone associated to a location group. */
zone?: ValueTypes['DeliveryZone'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DeliveryLocationGroupZones. */
['DeliveryLocationGroupZoneConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DeliveryLocationGroupZoneEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DeliveryLocationGroupZone and a cursor during pagination. */
['DeliveryLocationGroupZoneEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DeliveryLocationGroupZoneEdge. */
node?: ValueTypes['DeliveryLocationGroupZone'];
__typename?: boolean;
}>;
/** The input fields for a delivery zone associated to a location group and profile. */
['DeliveryLocationGroupZoneInput']: {
/** A globally-unique identifier of the zone. */
id?: string | null;
/** The name of the zone. */
name?: string | null;
/** A list of countries to associate with the zone. */
countries?: ValueTypes['DeliveryCountryInput'][];
/** A list of method definitions to create. */
methodDefinitionsToCreate?: ValueTypes['DeliveryMethodDefinitionInput'][];
/** A list of method definitions to update. */
methodDefinitionsToUpdate?: ValueTypes['DeliveryMethodDefinitionInput'][];
};
/** The delivery method used by a fulfillment order. */
['DeliveryMethod']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The type of the delivery method. */
methodType?: boolean;
__typename?: boolean;
}>;
/** A method definition contains the delivery rate and the conditions that must be met for the method to be
applied. */
['DeliveryMethodDefinition']: AliasType<{
/** Whether this method definition is active. */
active?: boolean;
/** The description of the method definition. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The method conditions that must pass for this method definition to be applied to an order. */
methodConditions?: ValueTypes['DeliveryCondition'];
/** The name of the method definition. */
name?: boolean;
/** The provided rate for this method definition, from a rate definition or participant. */
rateProvider?: ValueTypes['DeliveryRateProvider'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DeliveryMethodDefinitions. */
['DeliveryMethodDefinitionConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DeliveryMethodDefinitionEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** The number of method definitions for a zone, separated into merchant-owned and participant definitions. */
['DeliveryMethodDefinitionCounts']: AliasType<{
/** The number of participant method definitions for the specified zone. */
participantDefinitionsCount?: boolean;
/** The number of merchant-defined method definitions for the specified zone. */
rateDefinitionsCount?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type which holds one DeliveryMethodDefinition and a cursor during pagination. */
['DeliveryMethodDefinitionEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DeliveryMethodDefinitionEdge. */
node?: ValueTypes['DeliveryMethodDefinition'];
__typename?: boolean;
}>;
/** The input fields for a method definition. */
['DeliveryMethodDefinitionInput']: {
/** A globally-unique identifier of the method definition. Use only when updating a method definiton. */
id?: string | null;
/** The name of the method definition. */
name?: string | null;
/** The description of the method definition. */
description?: string | null;
/** Whether to use this method definition during rate calculation. */
active?: boolean | null;
/** A rate definition to apply to the method definition. */
rateDefinition?: ValueTypes['DeliveryRateDefinitionInput'] | null;
/** A participant to apply to the method definition. */
participant?: ValueTypes['DeliveryParticipantInput'] | null;
/** A list of weight conditions on the method definition. */
weightConditionsToCreate?: ValueTypes['DeliveryWeightConditionInput'][];
/** A list of price conditions on the method definition. */
priceConditionsToCreate?: ValueTypes['DeliveryPriceConditionInput'][];
/** A list of conditions to update on the method definition. */
conditionsToUpdate?: ValueTypes['DeliveryUpdateConditionInput'][];
};
/** The different types of method definitions to filter by. */
['DeliveryMethodDefinitionType']: DeliveryMethodDefinitionType;
/** Possible method types that a delivery method can have. */
['DeliveryMethodType']: DeliveryMethodType;
/** A participant defines carrier-calculated rates for shipping services
with a possible merchant-defined fixed fee or a percentage-of-rate fee. */
['DeliveryParticipant']: AliasType<{
/** Whether to display new shipping services automatically to the customer when the service becomes available. */
adaptToNewServicesFlag?: boolean;
/** The carrier used for this participant. */
carrierService?: ValueTypes['DeliveryCarrierService'];
/** The merchant-defined fixed fee for this participant. */
fixedFee?: ValueTypes['MoneyV2'];
/** A globally-unique identifier. */
id?: boolean;
/** The carrier-specific services offered by the participant, and whether each service is active. */
participantServices?: ValueTypes['DeliveryParticipantService'];
/** The merchant-defined percentage-of-rate fee for this participant. */
percentageOfRateFee?: boolean;
__typename?: boolean;
}>;
/** The input fields for a participant. */
['DeliveryParticipantInput']: {
/** The ID of the participant. */
id?: string | null;
/** The ID of the carrier service for this participant. */
carrierServiceId?: string | null;
/** The fixed feed that is defined by the merchant for this participant. */
fixedFee?: ValueTypes['MoneyInput'] | null;
/** The merchant-defined percentage-of-rate fee for this participant. */
percentageOfRateFee?: number | null;
/** The list of shipping services offered by the participant. */
participantServices?: ValueTypes['DeliveryParticipantServiceInput'][];
/** Whether to automatically display new shipping services to the customer when a service becomes available. */
adaptToNewServices?: boolean | null;
};
/** A mail service provided by the participant. */
['DeliveryParticipantService']: AliasType<{
/** Whether the service is active. */
active?: boolean;
/** The name of the service. */
name?: boolean;
__typename?: boolean;
}>;
/** The input fields for a shipping service provided by a participant. */
['DeliveryParticipantServiceInput']: {
/** The name of the service. */
name: string;
/** Whether the service is active. */
active: boolean;
};
/** The input fields for a price-based condition of a delivery method definition. */
['DeliveryPriceConditionInput']: {
/** The monetary value to compare the price of an order to. */
criteria?: ValueTypes['MoneyInput'] | null;
/** The operator to use for comparison. */
operator?: ValueTypes['DeliveryConditionOperator'] | null;
};
/** How many product variants are in a profile. This count is capped at 500. */
['DeliveryProductVariantsCount']: AliasType<{
/** Whether the count has reached the cap of 500. */
capped?: boolean;
/** The product variant count. */
count?: boolean;
__typename?: boolean;
}>;
/** A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. */
['DeliveryProfile']: AliasType<{
/** The number of active shipping rates for the profile. */
activeMethodDefinitionsCount?: boolean;
/** Whether this is the default profile. */
default?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Whether this shop has enabled legacy compatibility mode for delivery profiles. */
legacyMode?: boolean;
/** The number of locations without rates defined. */
locationsWithoutRatesCount?: boolean;
/** The name of the delivery profile. */
name?: boolean;
/** The number of active origin locations for the profile. */
originLocationCount?: boolean;
/** The number of product variants for this profile. The count for the default profile is not supported and will return -1. */
productVariantsCount?: boolean;
/** How many product variants are in this profile. */
productVariantsCountV2?: ValueTypes['DeliveryProductVariantsCount'];
profileItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?:
| boolean
| null /** Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported. */;
sortKey?: ValueTypes['ProfileItemSortKeys'] | null;
},
ValueTypes['DeliveryProfileItemConnection']
];
/** The location groups and associated zones using this profile. */
profileLocationGroups?: ValueTypes['DeliveryProfileLocationGroup'];
sellingPlanGroups?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SellingPlanGroupConnection']
];
/** List of locations that have not been assigned to a location group for this profile. */
unassignedLocations?: ValueTypes['Location'];
/** The number of countries with active rates to deliver to. */
zoneCountryCount?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DeliveryProfiles. */
['DeliveryProfileConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DeliveryProfileEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DeliveryProfile and a cursor during pagination. */
['DeliveryProfileEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DeliveryProfileEdge. */
node?: ValueTypes['DeliveryProfile'];
__typename?: boolean;
}>;
/** The input fields for a delivery profile. */
['DeliveryProfileInput']: {
/** The name of the delivery profile. */
name?: string | null;
/** The list of location groups associated with the delivery profile. */
profileLocationGroups?: ValueTypes['DeliveryProfileLocationGroupInput'][];
/** The list of location groups to be created in the delivery profile. */
locationGroupsToCreate?: ValueTypes['DeliveryProfileLocationGroupInput'][];
/** The list of location groups to be updated in the delivery profile. */
locationGroupsToUpdate?: ValueTypes['DeliveryProfileLocationGroupInput'][];
/** The list of location groups to be deleted from the delivery profile. */
locationGroupsToDelete?: string[];
/** The list of product variant IDs to be associated with the delivery profile. */
variantsToAssociate?: string[];
/** The list of product variant IDs to be dissociated from the delivery profile.
The dissociated product variants are moved back to the default delivery profile. */
variantsToDissociate?: string[];
/** The list of zone IDs to delete. */
zonesToDelete?: string[];
/** The list of method definition IDs to delete. */
methodDefinitionsToDelete?: string[];
/** The list of condition IDs to delete. */
conditionsToDelete?: string[];
/** The list of selling plan groups to be associated with the delivery profile. */
sellingPlanGroupsToAssociate?: string[];
/** The list of selling plan groups to be dissociated with the delivery profile. */
sellingPlanGroupsToDissociate?: string[];
};
/** A product and the subset of associated variants that are part of this delivery profile. */
['DeliveryProfileItem']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** A product associated with this profile. */
product?: ValueTypes['Product'];
variants?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?:
| boolean
| null /** Sort the underlying list by the given key. This argument is deprecated: Profile item variant sorting is no longer supported. */;
sortKey?: ValueTypes['ProductVariantSortKeys'] | null;
},
ValueTypes['ProductVariantConnection']
];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DeliveryProfileItems. */
['DeliveryProfileItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DeliveryProfileItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DeliveryProfileItem and a cursor during pagination. */
['DeliveryProfileItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DeliveryProfileItemEdge. */
node?: ValueTypes['DeliveryProfileItem'];
__typename?: boolean;
}>;
/** Links a location group with zones. Both are associated to a delivery profile. */
['DeliveryProfileLocationGroup']: AliasType<{
/** The countries already selected in any zone for the specified location group. */
countriesInAnyZone?: ValueTypes['DeliveryCountryAndZone'];
/** The collection of locations that make up the specified location group. */
locationGroup?: ValueTypes['DeliveryLocationGroup'];
locationGroupZones?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['DeliveryLocationGroupZoneConnection']
];
__typename?: boolean;
}>;
/** The input fields for a location group associated to a delivery profile. */
['DeliveryProfileLocationGroupInput']: {
/** The globally-unique identifier of the delivery profile location group. */
id?: string | null;
/** The list of location IDs to be moved to this location group. */
locations?: string[];
/** The list of location group zones to create. */
zonesToCreate?: ValueTypes['DeliveryLocationGroupZoneInput'][];
/** The list of location group zones to update. */
zonesToUpdate?: ValueTypes['DeliveryLocationGroupZoneInput'][];
};
/** A region that is used to define a shipping zone. */
['DeliveryProvince']: AliasType<{
/** The code of the region. */
code?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The full name of the region. */
name?: boolean;
/** The translated name of the region. The translation returned is based on the system's locale. */
translatedName?: boolean;
__typename?: boolean;
}>;
/** The input fields to specify a region. */
['DeliveryProvinceInput']: {
/** The code of the region. */
code: string;
};
/** The merchant-defined rate of the [DeliveryMethodDefinition](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryMethodDefinition). */
['DeliveryRateDefinition']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The price of this rate. */
price?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** The input fields for a rate definition. */
['DeliveryRateDefinitionInput']: {
/** A globally-unique identifier of the rate definition. */
id?: string | null;
/** The price of the rate definition. */
price: ValueTypes['MoneyInput'];
};
/** A rate provided by a merchant-defined rate or a participant. */
['DeliveryRateProvider']: AliasType<{
['...on DeliveryParticipant']: ValueTypes['DeliveryParticipant'];
['...on DeliveryRateDefinition']: ValueTypes['DeliveryRateDefinition'];
__typename?: boolean;
}>;
/** The `DeliverySetting` object enables you to manage shop-wide shipping settings.
You can enable legacy compatibility mode for the multi-location delivery profiles feature
if the legacy mode isn't blocked. */
['DeliverySetting']: AliasType<{
/** Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned. */
legacyModeBlocked?: ValueTypes['DeliveryLegacyModeBlocked'];
/** Enables legacy compatability mode for the multi-location delivery profiles feature. */
legacyModeProfiles?: boolean;
__typename?: boolean;
}>;
/** The input fields for shop-level delivery settings. */
['DeliverySettingInput']: {
/** Whether legacy compatability mode is enabled for the multi-location delivery profiles feature. */
legacyModeProfiles?: boolean | null;
};
/** Return type for `deliverySettingUpdate` mutation. */
['DeliverySettingUpdatePayload']: AliasType<{
/** The updated delivery shop level settings. */
setting?: ValueTypes['DeliverySetting'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `deliveryShippingOriginAssign` mutation. */
['DeliveryShippingOriginAssignPayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The input fields for updating the condition of a delivery method definition. */
['DeliveryUpdateConditionInput']: {
/** A globally-unique identifier of the condition. */
id: string;
/** The value that will be used in comparison. */
criteria?: number | null;
/** The unit associated with the value that will be used in comparison. */
criteriaUnit?: string | null;
/** The property of an order that will be used in comparison. */
field?: ValueTypes['DeliveryConditionField'] | null;
/** The operator to use for comparison. */
operator?: ValueTypes['DeliveryConditionOperator'] | null;
};
/** The input fields for a weight-based condition of a delivery method definition. */
['DeliveryWeightConditionInput']: {
/** The weight value to compare the weight of an order to. */
criteria?: ValueTypes['WeightInput'] | null;
/** The operator to use for comparison. */
operator?: ValueTypes['DeliveryConditionOperator'] | null;
};
/** A zone is a group of countries that have the same shipping rates. Customers can order products from a store only if they choose a shipping destination that's included in one of the store's zones. */
['DeliveryZone']: AliasType<{
/** The list of countries within the zone. */
countries?: ValueTypes['DeliveryCountry'];
/** A globally-unique identifier. */
id?: boolean;
/** The name of the zone. */
name?: boolean;
__typename?: boolean;
}>;
/** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */
['DigitalWallet']: DigitalWallet;
/** An amount discounting the line that has been allocated by an associated discount application. */
['DiscountAllocation']: AliasType<{
/** Money amount allocated by the discount application. */
allocatedAmount?: ValueTypes['MoneyV2'];
/** Money amount allocated by the discount application in shop and presentment currencies. */
allocatedAmountSet?: ValueTypes['MoneyBag'];
/** The discount of which this allocated amount originated from. */
discountApplication?: ValueTypes['DiscountApplication'];
__typename?: boolean;
}>;
/** The fixed amount value of a discount. */
['DiscountAmount']: AliasType<{
/** The value of the discount. */
amount?: ValueTypes['MoneyV2'];
/** If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. */
appliesOnEachItem?: boolean;
__typename?: boolean;
}>;
/** Specifies the value of the discount and how it is applied. */
['DiscountAmountInput']: {
/** The value of the discount. */
amount?: ValueTypes['Decimal'] | null;
/** If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. */
appliesOnEachItem?: boolean | null;
};
/** Discount applications capture the intentions of a discount source at
the time of application on an order's line items or shipping lines. */
['DiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** An ordered index that can be used to identify the discount application and indicate the precedence
of the discount application for calculations. */
index?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
['...on AutomaticDiscountApplication']?: Omit<ValueTypes['AutomaticDiscountApplication'], keyof ValueTypes['DiscountApplication']>;
['...on DiscountCodeApplication']?: Omit<ValueTypes['DiscountCodeApplication'], keyof ValueTypes['DiscountApplication']>;
['...on ManualDiscountApplication']?: Omit<ValueTypes['ManualDiscountApplication'], keyof ValueTypes['DiscountApplication']>;
['...on ScriptDiscountApplication']?: Omit<ValueTypes['ScriptDiscountApplication'], keyof ValueTypes['DiscountApplication']>;
__typename?: boolean;
}>;
/** The method by which the discount's value is allocated onto its entitled lines. */
['DiscountApplicationAllocationMethod']: DiscountApplicationAllocationMethod;
/** An auto-generated type for paginating through multiple DiscountApplications. */
['DiscountApplicationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DiscountApplicationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DiscountApplication and a cursor during pagination. */
['DiscountApplicationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DiscountApplicationEdge. */
node?: ValueTypes['DiscountApplication'];
__typename?: boolean;
}>;
/** The method by which the discount's value is allocated onto its entitled lines. */
['DiscountApplicationLevel']: DiscountApplicationLevel;
/** Which lines on the order that the discount is allocated over, of the type
defined by the Discount Application's target_type. */
['DiscountApplicationTargetSelection']: DiscountApplicationTargetSelection;
/** The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. */
['DiscountApplicationTargetType']: DiscountApplicationTargetType;
/** An automatic discount. */
['DiscountAutomatic']: AliasType<{
['...on DiscountAutomaticBasic']: ValueTypes['DiscountAutomaticBasic'];
['...on DiscountAutomaticBxgy']: ValueTypes['DiscountAutomaticBxgy'];
__typename?: boolean;
}>;
/** Return type for `discountAutomaticActivate` mutation. */
['DiscountAutomaticActivatePayload']: AliasType<{
/** The activated automatic discount. */
automaticDiscountNode?: ValueTypes['DiscountAutomaticNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** An automatic basic discount. */
['DiscountAutomaticBasic']: AliasType<{
/** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */
asyncUsageCount?: boolean;
/** The date and time when the discount was created. */
createdAt?: boolean;
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGets'];
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: boolean;
/** The minimum subtotal or quantity that's required for the discount to be applied. */
minimumRequirement?: ValueTypes['DiscountMinimumRequirement'];
/** A short summary of the discount. */
shortSummary?: boolean;
/** The date and time when the discount starts. */
startsAt?: boolean;
/** The status of the discount. */
status?: boolean;
/** A detailed summary of the discount. */
summary?: boolean;
/** The title of the discount. */
title?: boolean;
/** The number of times that the discount has been used. */
usageCount?: boolean;
__typename?: boolean;
}>;
/** Return type for `discountAutomaticBasicCreate` mutation. */
['DiscountAutomaticBasicCreatePayload']: AliasType<{
/** The created automatic discount. */
automaticDiscountNode?: ValueTypes['DiscountAutomaticNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Specifies input field to create or update automatic basic discount. */
['DiscountAutomaticBasicInput']: {
/** The title of the discount. */
title?: string | null;
/** The date and time when the discount starts. */
startsAt?: ValueTypes['DateTime'] | null;
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: ValueTypes['DateTime'] | null;
/** The minimum subtotal or quantity that's required for the discount to be applied. */
minimumRequirement?: ValueTypes['DiscountMinimumRequirementInput'] | null;
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGetsInput'] | null;
};
/** Return type for `discountAutomaticBasicUpdate` mutation. */
['DiscountAutomaticBasicUpdatePayload']: AliasType<{
/** The updated automatic discount. */
automaticDiscountNode?: ValueTypes['DiscountAutomaticNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Return type for `discountAutomaticBulkDelete` mutation. */
['DiscountAutomaticBulkDeletePayload']: AliasType<{
/** The asynchronous job removing the automatic discounts. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** An automatic BXGY discount. */
['DiscountAutomaticBxgy']: AliasType<{
/** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */
asyncUsageCount?: boolean;
/** The date and time when the discount was created. */
createdAt?: boolean;
/** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */
customerBuys?: ValueTypes['DiscountCustomerBuys'];
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGets'];
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: boolean;
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
/** A legacy unique identifier for the discount. */
id?: boolean;
/** The date and time when the discount starts. */
startsAt?: boolean;
/** The status of the discount. */
status?: boolean;
/** A detailed summary of the discount. */
summary?: boolean;
/** The title of the discount. */
title?: boolean;
/** The number of times that the discount has been used. */
usageCount?: boolean;
/** The maximum number of times that the discount can be applied to an order. */
usesPerOrderLimit?: boolean;
__typename?: boolean;
}>;
/** Return type for `discountAutomaticBxgyCreate` mutation. */
['DiscountAutomaticBxgyCreatePayload']: AliasType<{
/** The created automatic discount. */
automaticDiscountNode?: ValueTypes['DiscountAutomaticNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Specifies input field to create or update automatic bogo discount. */
['DiscountAutomaticBxgyInput']: {
/** The date and time when the discount starts. */
startsAt?: ValueTypes['DateTime'] | null;
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: ValueTypes['DateTime'] | null;
/** The title of the discount. */
title?: string | null;
/** The maximum number of times that the discount can be applied to an order. */
usesPerOrderLimit?: ValueTypes['UnsignedInt64'] | null;
/** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */
customerBuys?: ValueTypes['DiscountCustomerBuysInput'] | null;
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGetsInput'] | null;
};
/** Return type for `discountAutomaticBxgyUpdate` mutation. */
['DiscountAutomaticBxgyUpdatePayload']: AliasType<{
/** The updated automatic discount. */
automaticDiscountNode?: ValueTypes['DiscountAutomaticNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DiscountAutomatics. */
['DiscountAutomaticConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DiscountAutomaticEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `discountAutomaticDeactivate` mutation. */
['DiscountAutomaticDeactivatePayload']: AliasType<{
/** The deactivated automatic discount. */
automaticDiscountNode?: ValueTypes['DiscountAutomaticNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Return type for `discountAutomaticDelete` mutation. */
['DiscountAutomaticDeletePayload']: AliasType<{
/** The deleted automatic discount ID. */
deletedAutomaticDiscountId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DiscountAutomatic and a cursor during pagination. */
['DiscountAutomaticEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DiscountAutomaticEdge. */
node?: ValueTypes['DiscountAutomatic'];
__typename?: boolean;
}>;
/** An automatic discount wrapper node. */
['DiscountAutomaticNode']: AliasType<{
/** An automatic discount. */
automaticDiscount?: ValueTypes['DiscountAutomatic'];
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
/** A globally-unique identifier. */
id?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DiscountAutomaticNodes. */
['DiscountAutomaticNodeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DiscountAutomaticNodeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DiscountAutomaticNode and a cursor during pagination. */
['DiscountAutomaticNodeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DiscountAutomaticNodeEdge. */
node?: ValueTypes['DiscountAutomaticNode'];
__typename?: boolean;
}>;
/** A code discount. */
['DiscountCode']: AliasType<{
['...on DiscountCodeBasic']: ValueTypes['DiscountCodeBasic'];
['...on DiscountCodeBxgy']: ValueTypes['DiscountCodeBxgy'];
['...on DiscountCodeFreeShipping']: ValueTypes['DiscountCodeFreeShipping'];
__typename?: boolean;
}>;
/** Return type for `discountCodeActivate` mutation. */
['DiscountCodeActivatePayload']: AliasType<{
/** The activated code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Discount code applications capture the intentions of a discount code at
the time that it is applied onto an order. */
['DiscountCodeApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The string identifying the discount code that was used at the time of application. */
code?: boolean;
/** An ordered index that can be used to identify the discount application and indicate the precedence
of the discount application for calculations. */
index?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** A basic code discount. */
['DiscountCodeBasic']: AliasType<{
/** Whether the discount can be applied only once per customer. */
appliesOncePerCustomer?: boolean;
/** The number of times that the discount has been used. */
asyncUsageCount?: boolean;
/** The number of redeem codes for the discount. */
codeCount?: boolean;
codes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DiscountCodeSortKeys'] | null /** Supported filter parameters:
- `times_used`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['DiscountRedeemCodeConnection']
];
/** The date and time when the discount was created. */
createdAt?: boolean;
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGets'];
/** The customers that can use the discount. */
customerSelection?: ValueTypes['DiscountCustomerSelection'];
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: boolean;
/** Indicates whether there are any timeline comments on the discount. */
hasTimelineComment?: boolean;
/** The minimum subtotal or quantity that's required for the discount to be applied. */
minimumRequirement?: ValueTypes['DiscountMinimumRequirement'];
/** The number of times a discount applies on recurring purchases (subscriptions). */
recurringCycleLimit?: boolean;
/** URLs that can be used to share the discount. */
shareableUrls?: ValueTypes['DiscountShareableUrl'];
/** A short summary of the discount. */
shortSummary?: boolean;
/** The date and time when the discount starts. */
startsAt?: boolean;
/** The status of the discount. */
status?: boolean;
/** A detailed summary of the discount. */
summary?: boolean;
/** The title of the discount. */
title?: boolean;
/** The total sales from orders where the discount was used. */
totalSales?: ValueTypes['MoneyV2'];
/** The maximum number of times that the discount can be used. */
usageLimit?: boolean;
__typename?: boolean;
}>;
/** Return type for `discountCodeBasicCreate` mutation. */
['DiscountCodeBasicCreatePayload']: AliasType<{
/** The created code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Specifies input field to create or update code basic discount. */
['DiscountCodeBasicInput']: {
/** The title of the discount. */
title?: string | null;
/** The date and time when the discount starts. */
startsAt?: ValueTypes['DateTime'] | null;
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: ValueTypes['DateTime'] | null;
/** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */
usageLimit?: number | null;
/** Whether the discount can be applied only once per customer. */
appliesOncePerCustomer?: boolean | null;
/** The minimum subtotal or quantity that's required for the discount to be applied. */
minimumRequirement?: ValueTypes['DiscountMinimumRequirementInput'] | null;
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGetsInput'] | null;
/** The customers that can use the discount. */
customerSelection?: ValueTypes['DiscountCustomerSelectionInput'] | null;
/** The code to use the discount. */
code?: string | null;
/** The number of times a discount applies on recurring purchases (subscriptions). */
recurringCycleLimit?: number | null;
};
/** Return type for `discountCodeBasicUpdate` mutation. */
['DiscountCodeBasicUpdatePayload']: AliasType<{
/** The updated code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Return type for `discountCodeBulkActivate` mutation. */
['DiscountCodeBulkActivatePayload']: AliasType<{
/** The asynchronous job that activates the code discounts. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Return type for `discountCodeBulkDeactivate` mutation. */
['DiscountCodeBulkDeactivatePayload']: AliasType<{
/** The asynchronous job that deactivates the code discounts. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Return type for `discountCodeBulkDelete` mutation. */
['DiscountCodeBulkDeletePayload']: AliasType<{
/** The asynchronous job that deletes the code discounts. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** A BXGY code discount. */
['DiscountCodeBxgy']: AliasType<{
/** Whether the discount can be applied only once per customer. */
appliesOncePerCustomer?: boolean;
/** The number of times that the discount has been used. */
asyncUsageCount?: boolean;
/** The number of redeem codes for the discount. */
codeCount?: boolean;
codes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DiscountCodeSortKeys'] | null /** Supported filter parameters:
- `times_used`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['DiscountRedeemCodeConnection']
];
/** The date and time when the discount was created. */
createdAt?: boolean;
/** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */
customerBuys?: ValueTypes['DiscountCustomerBuys'];
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGets'];
/** The customers that can use the discount. */
customerSelection?: ValueTypes['DiscountCustomerSelection'];
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: boolean;
/** Indicates whether there are any timeline comments on the discount. */
hasTimelineComment?: boolean;
/** URLs that can be used to share the discount. */
shareableUrls?: ValueTypes['DiscountShareableUrl'];
/** The date and time when the discount starts. */
startsAt?: boolean;
/** The status of the discount. */
status?: boolean;
/** A detailed summary of the discount. */
summary?: boolean;
/** The title of the discount. */
title?: boolean;
/** The total sales from orders where the discount was used. */
totalSales?: ValueTypes['MoneyV2'];
/** The maximum number of times that the discount can be used. */
usageLimit?: boolean;
/** The maximum number of times that the discount can be applied to an order. */
usesPerOrderLimit?: boolean;
__typename?: boolean;
}>;
/** Return type for `discountCodeBxgyCreate` mutation. */
['DiscountCodeBxgyCreatePayload']: AliasType<{
/** The created code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Specifies input field to create or update a BXGY code discount. */
['DiscountCodeBxgyInput']: {
/** The title of the discount. */
title?: string | null;
/** The date and time when the discount starts. */
startsAt?: ValueTypes['DateTime'] | null;
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: ValueTypes['DateTime'] | null;
/** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */
customerBuys?: ValueTypes['DiscountCustomerBuysInput'] | null;
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
customerGets?: ValueTypes['DiscountCustomerGetsInput'] | null;
/** The customers that can use the discount. */
customerSelection?: ValueTypes['DiscountCustomerSelectionInput'] | null;
/** The code to use the discount. */
code?: string | null;
/** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */
usageLimit?: number | null;
/** The maximum number of times that the discount can be applied to an order. */
usesPerOrderLimit?: number | null;
/** Whether the discount can be applied only once per customer. */
appliesOncePerCustomer?: boolean | null;
};
/** Return type for `discountCodeBxgyUpdate` mutation. */
['DiscountCodeBxgyUpdatePayload']: AliasType<{
/** The updated code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Return type for `discountCodeDeactivate` mutation. */
['DiscountCodeDeactivatePayload']: AliasType<{
/** The deactivated code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Return type for `discountCodeDelete` mutation. */
['DiscountCodeDeletePayload']: AliasType<{
/** The deleted code discount ID. */
deletedCodeDiscountId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** A free shipping code discount. */
['DiscountCodeFreeShipping']: AliasType<{
/** Whether the discount applies on regular one-time-purchase shipping lines. */
appliesOnOneTimePurchase?: boolean;
/** Whether the discount applies on subscription shipping lines. */
appliesOnSubscription?: boolean;
/** Whether the discount can be applied only once per customer. */
appliesOncePerCustomer?: boolean;
/** The number of times that the discount has been used. */
asyncUsageCount?: boolean;
/** The number of redeem codes for the discount. */
codeCount?: boolean;
codes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DiscountCodeSortKeys'] | null /** Supported filter parameters:
- `times_used`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['DiscountRedeemCodeConnection']
];
/** The date and time when the discount was created. */
createdAt?: boolean;
/** The customers that can use the discount. */
customerSelection?: ValueTypes['DiscountCustomerSelection'];
/** A shipping destination that qualifies for the discount. */
destinationSelection?: ValueTypes['DiscountShippingDestinationSelection'];
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: boolean;
/** Indicates whether there are any timeline comments on the discount. */
hasTimelineComment?: boolean;
/** The maximum shipping price amount accepted to qualify for the discount. */
maximumShippingPrice?: ValueTypes['MoneyV2'];
/** The minimum subtotal or quantity that's required for the discount to be applied. */
minimumRequirement?: ValueTypes['DiscountMinimumRequirement'];
/** The number of times a discount applies on recurring purchases (subscriptions). */
recurringCycleLimit?: boolean;
/** URLs that can be used to share the discount. */
shareableUrls?: ValueTypes['DiscountShareableUrl'];
/** A short summary of the discount. */
shortSummary?: boolean;
/** The date and time when the discount starts. */
startsAt?: boolean;
/** The status of the discount. */
status?: boolean;
/** A detailed summary of the discount. */
summary?: boolean;
/** The title of the discount. */
title?: boolean;
/** The total sales from orders where the discount was used. */
totalSales?: ValueTypes['MoneyV2'];
/** The maximum number of times that the discount can be used. */
usageLimit?: boolean;
__typename?: boolean;
}>;
/** Return type for `discountCodeFreeShippingCreate` mutation. */
['DiscountCodeFreeShippingCreatePayload']: AliasType<{
/** The created code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Specifies input field to create or update free shipping code discount. */
['DiscountCodeFreeShippingInput']: {
/** The title of the discount. */
title?: string | null;
/** The date and time when the discount starts. */
startsAt?: ValueTypes['DateTime'] | null;
/** The date and time when the discount ends. For open-ended discounts, use `null`. */
endsAt?: ValueTypes['DateTime'] | null;
/** The code to use the discount. */
code?: string | null;
/** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */
usageLimit?: number | null;
/** Whether the discount can be applied only once per customer. */
appliesOncePerCustomer?: boolean | null;
/** The minimum subtotal or quantity that's required for the discount to be applied. */
minimumRequirement?: ValueTypes['DiscountMinimumRequirementInput'] | null;
/** The customers that can use the discount. */
customerSelection?: ValueTypes['DiscountCustomerSelectionInput'] | null;
/** A list of destinations where the discount will apply. */
destination?: ValueTypes['DiscountShippingDestinationSelectionInput'] | null;
/** The maximum shipping price that qualifies for the discount. */
maximumShippingPrice?: ValueTypes['Decimal'] | null;
/** The number of times a discount applies on recurring purchases (subscriptions). */
recurringCycleLimit?: number | null;
/** Whether the discount applies on regular one-time-purchase items. */
appliesOnOneTimePurchase?: boolean | null;
/** Whether the discount applies on subscription items. */
appliesOnSubscription?: boolean | null;
};
/** Return type for `discountCodeFreeShippingUpdate` mutation. */
['DiscountCodeFreeShippingUpdatePayload']: AliasType<{
/** The updated code discount. */
codeDiscountNode?: ValueTypes['DiscountCodeNode'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** A code discount wrapper node. */
['DiscountCodeNode']: AliasType<{
/** A code discount. */
codeDiscount?: ValueTypes['DiscountCode'];
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
/** A globally-unique identifier. */
id?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DiscountCodeNodes. */
['DiscountCodeNodeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DiscountCodeNodeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DiscountCodeNode and a cursor during pagination. */
['DiscountCodeNodeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DiscountCodeNodeEdge. */
node?: ValueTypes['DiscountCodeNode'];
__typename?: boolean;
}>;
/** Return type for `discountCodeRedeemCodeBulkDelete` mutation. */
['DiscountCodeRedeemCodeBulkDeletePayload']: AliasType<{
/** The asynchronous job that deletes the discount redeem codes. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the DiscountCode query. */
['DiscountCodeSortKeys']: DiscountCodeSortKeys;
/** A list of collections that the discount can have as a prerequisite or entitlement. */
['DiscountCollections']: AliasType<{
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CollectionConnection']
];
__typename?: boolean;
}>;
/** Specifies the collections attached to a discount. */
['DiscountCollectionsInput']: {
/** Specifies list of collection ids to add. */
add?: string[];
/** Specifies list of collection ids to remove. */
remove?: string[];
};
/** The shipping destination where the discount applies. */
['DiscountCountries']: AliasType<{
/** The codes for the countries where the discount can be used. */
countries?: boolean;
/** Whether the discount is applicable to countries that have not been defined in the shop's shipping zones. */
includeRestOfWorld?: boolean;
__typename?: boolean;
}>;
/** Specifies a list of countries to add or remove from the free shipping discount. */
['DiscountCountriesInput']: {
/** The country codes to add to the list of countries where the discount applies. */
add?: ValueTypes['CountryCode'][];
/** The country codes to remove from the list of countries where the discount applies. */
remove?: ValueTypes['CountryCode'][];
/** Whether the discount code is applicable to countries that have not been defined in the shop's shipping zones. */
includeRestOfWorld?: boolean | null;
};
/** Whether the discount applies to all countries. */
['DiscountCountryAll']: AliasType<{
/** Always true when resolved to this type. */
allCountries?: boolean;
__typename?: boolean;
}>;
/** Whether the discount applies to all customers. */
['DiscountCustomerAll']: AliasType<{
/** Always true when resolved to this type. */
allCustomers?: boolean;
__typename?: boolean;
}>;
/** The prerequisite items and prerequisite value. */
['DiscountCustomerBuys']: AliasType<{
/** The items required for the discount to be applicable. */
items?: ValueTypes['DiscountItems'];
/** The prerequisite value. */
value?: ValueTypes['DiscountCustomerBuysValue'];
__typename?: boolean;
}>;
/** Specifies the prerequisite items and prerequisite quantity. */
['DiscountCustomerBuysInput']: {
/** The quantity of prerequisite items. */
value?: ValueTypes['DiscountCustomerBuysValueInput'] | null;
/** The IDs of items that the customer buys. The items can be either collections or products. */
items?: ValueTypes['DiscountItemsInput'] | null;
};
/** The prerequisite quantity required for the discount to be applicable. */
['DiscountCustomerBuysValue']: AliasType<{
['...on DiscountPurchaseAmount']: ValueTypes['DiscountPurchaseAmount'];
['...on DiscountQuantity']: ValueTypes['DiscountQuantity'];
__typename?: boolean;
}>;
/** Specifies the prerequisite quantity for the discount. */
['DiscountCustomerBuysValueInput']: {
/** The quantity of prerequisite items. */
quantity?: ValueTypes['UnsignedInt64'] | null;
/** The prerequisite purchase amount required for the discount to be applicable. */
amount?: ValueTypes['Decimal'] | null;
};
/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */
['DiscountCustomerGets']: AliasType<{
/** Whether the discount applies on regular one-time-purchase items. */
appliesOnOneTimePurchase?: boolean;
/** Whether the discount applies on subscription items. */
appliesOnSubscription?: boolean;
/** The items to which the discount applies. */
items?: ValueTypes['DiscountItems'];
/** Entitled quantity and the discount value. */
value?: ValueTypes['DiscountCustomerGetsValue'];
__typename?: boolean;
}>;
/** Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount. */
['DiscountCustomerGetsInput']: {
/** The quantity of items discounted and the discount value. */
value?: ValueTypes['DiscountCustomerGetsValueInput'] | null;
/** The IDs of the items that the customer gets. The items can be either collections or products. */
items?: ValueTypes['DiscountItemsInput'] | null;
/** Whether the discount applies on regular one-time-purchase items. */
appliesOnOneTimePurchase?: boolean | null;
/** Whether the discount applies on subscription items. */
appliesOnSubscription?: boolean | null;
};
/** The value of the discount and how it will be applied. */
['DiscountCustomerGetsValue']: AliasType<{
['...on DiscountAmount']: ValueTypes['DiscountAmount'];
['...on DiscountOnQuantity']: ValueTypes['DiscountOnQuantity'];
['...on DiscountPercentage']: ValueTypes['DiscountPercentage'];
__typename?: boolean;
}>;
/** Specifies the quantity of items discounted and the discount value. */
['DiscountCustomerGetsValueInput']: {
/** The quantity of the items that are discounted and the discount value. */
discountOnQuantity?: ValueTypes['DiscountOnQuantityInput'] | null;
/** The percentage value of the discount. Value must be between 0.00 - 1.00. */
percentage?: number | null;
/** The value of the discount. */
discountAmount?: ValueTypes['DiscountAmountInput'] | null;
};
/** A list of customer saved searches that contain the customers to whom the discount applies. */
['DiscountCustomerSavedSearches']: AliasType<{
/** A list of customer saved searches that contain the customers who can use the discount. */
savedSearches?: ValueTypes['SavedSearch'];
__typename?: boolean;
}>;
/** Specifies which customer saved searches to add to or remove from the discount. */
['DiscountCustomerSavedSearchesInput']: {
/** A list of customer saved searches to add to the current list of customer saved searches. */
add?: string[];
/** A list of customer saved searches to remove from the current list of customer saved searches. */
remove?: string[];
};
/** The type used for targeting a set of customers who are eligible for the discount. For example, the discount might be available to all customers or it might only be available to a specific set of customers. You can define the set of customers by targeting a list of customer segments, or by targeting a list of specific customers. */
['DiscountCustomerSelection']: AliasType<{
['...on DiscountCustomerAll']: ValueTypes['DiscountCustomerAll'];
['...on DiscountCustomerSavedSearches']: ValueTypes['DiscountCustomerSavedSearches'];
['...on DiscountCustomers']: ValueTypes['DiscountCustomers'];
__typename?: boolean;
}>;
/** Specifies the customers who can use this discount. */
['DiscountCustomerSelectionInput']: {
/** Whether all customers can use this discount. */
all?: boolean | null;
/** The list of customer IDs to add or remove from the list of customers. */
customers?: ValueTypes['DiscountCustomersInput'] | null;
};
/** A list of customers to whom the discount applies. */
['DiscountCustomers']: AliasType<{
/** A list of the customers that can use the discount. */
customers?: ValueTypes['Customer'];
__typename?: boolean;
}>;
/** Specifies which customers to add to or remove from the discount. */
['DiscountCustomersInput']: {
/** A list of customers to add to the current list of customers who can use the discount. */
add?: string[];
/** A list of customers to remove from the current list of customers who can use the discount. */
remove?: string[];
};
/** The type of discount that will be applied. Currently, only percentage off is supported. */
['DiscountEffect']: AliasType<{
['...on DiscountPercentage']: ValueTypes['DiscountPercentage'];
__typename?: boolean;
}>;
/** Specifies how the discount will be applied. Currently, only percentage off is supported. */
['DiscountEffectInput']: {
/** The percentage value of the discount. Value must be between 0.00 - 1.00. */
percentage?: number | null;
};
/** Possible error codes that can be returned by `DiscountUserError`. */
['DiscountErrorCode']: DiscountErrorCode;
/** Entitled or prerequisite items on a discount. An item could be either collection or product or product_variant. */
['DiscountItems']: AliasType<{
['...on AllDiscountItems']: ValueTypes['AllDiscountItems'];
['...on DiscountCollections']: ValueTypes['DiscountCollections'];
['...on DiscountProducts']: ValueTypes['DiscountProducts'];
__typename?: boolean;
}>;
/** Specifies the items attached to a discount. */
['DiscountItemsInput']: {
/** The products and product variants that are attached to a discount. */
products?: ValueTypes['DiscountProductsInput'] | null;
/** The collections that are attached to a discount. */
collections?: ValueTypes['DiscountCollectionsInput'] | null;
/** Whether all items should be selected. */
all?: boolean | null;
};
/** The minimum quantity of items required for the discount to apply. */
['DiscountMinimumQuantity']: AliasType<{
/** The minimum quantity of items that's required for the discount to be applied. */
greaterThanOrEqualToQuantity?: boolean;
__typename?: boolean;
}>;
/** Specifies the quantity minimum requirements for a discount. */
['DiscountMinimumQuantityInput']: {
/** The minimum quantity of items that's required for the discount to be applied. */
greaterThanOrEqualToQuantity?: ValueTypes['UnsignedInt64'] | null;
};
/** The minimum subtotal or quantity requirements for the discount. */
['DiscountMinimumRequirement']: AliasType<{
['...on DiscountMinimumQuantity']: ValueTypes['DiscountMinimumQuantity'];
['...on DiscountMinimumSubtotal']: ValueTypes['DiscountMinimumSubtotal'];
__typename?: boolean;
}>;
/** Specifies the quantity or subtotal minimum requirements for a discount. */
['DiscountMinimumRequirementInput']: {
/** The minimum required quantity. */
quantity?: ValueTypes['DiscountMinimumQuantityInput'] | null;
/** The minimum required subtotal. */
subtotal?: ValueTypes['DiscountMinimumSubtotalInput'] | null;
};
/** The minimum subtotal required for the discount to apply. */
['DiscountMinimumSubtotal']: AliasType<{
/** The minimum subtotal that's required for the discount to be applied. */
greaterThanOrEqualToSubtotal?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** Specifies the subtotal minimum requirements for a discount. */
['DiscountMinimumSubtotalInput']: {
/** The minimum subtotal that's required for the discount to be applied. */
greaterThanOrEqualToSubtotal?: ValueTypes['Decimal'] | null;
};
/** The quantity of items discounted, the discount value, and how the discount will be applied. */
['DiscountOnQuantity']: AliasType<{
/** The discount's effect on qualifying items. */
effect?: ValueTypes['DiscountEffect'];
/** The number of items being discounted. */
quantity?: ValueTypes['DiscountQuantity'];
__typename?: boolean;
}>;
/** Specifies the quantity of items discounted and the discount value. */
['DiscountOnQuantityInput']: {
/** The quantity of items that are discounted. */
quantity?: ValueTypes['UnsignedInt64'] | null;
/** The percentage value of the discount. */
effect?: ValueTypes['DiscountEffectInput'] | null;
};
/** The percentage value of the discount. */
['DiscountPercentage']: AliasType<{
/** The percentage value of the discount. */
percentage?: boolean;
__typename?: boolean;
}>;
/** The entitled or prerequisite products and product variants for a discount. */
['DiscountProducts']: AliasType<{
productVariants?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductVariantConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductConnection']
];
__typename?: boolean;
}>;
/** Specifies the products and product variants attached to a discount. */
['DiscountProductsInput']: {
/** Specifies list of product ids to add. */
productsToAdd?: string[];
/** Specifies list of product ids to remove. */
productsToRemove?: string[];
/** Specifies list of product variant ids to add. */
productVariantsToAdd?: string[];
/** Specifies list of product variant ids to remove. */
productVariantsToRemove?: string[];
};
/** The prerequisite purchase amount required for the discount to be applicable. */
['DiscountPurchaseAmount']: AliasType<{
/** Decimal money amount. */
amount?: boolean;
__typename?: boolean;
}>;
/** The quantity of items in discount. */
['DiscountQuantity']: AliasType<{
/** The quantity of items. */
quantity?: boolean;
__typename?: boolean;
}>;
/** A redeem code for a code discount. */
['DiscountRedeemCode']: AliasType<{
/** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */
asyncUsageCount?: boolean;
/** The code of a discount. */
code?: boolean;
/** The application that created the discount code. */
createdBy?: ValueTypes['App'];
/** A globally-unique identifier of the discount redeem code. */
id?: boolean;
__typename?: boolean;
}>;
/** Return type for `discountRedeemCodeBulkAdd` mutation. */
['DiscountRedeemCodeBulkAddPayload']: AliasType<{
/** Tracks the progress of the bulk code creation. */
bulkCreation?: ValueTypes['DiscountRedeemCodeBulkCreation'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** Represents a bulk creation of discount redeem codes. */
['DiscountRedeemCodeBulkCreation']: AliasType<{
codes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['DiscountRedeemCodeBulkCreationCodeConnection']
];
/** The number of codes to create. */
codesCount?: boolean;
/** The date and time when the bulk creation was created. */
createdAt?: boolean;
/** The code discount associated with the created codes. */
discountCode?: ValueTypes['DiscountCodeNode'];
/** Whether the bulk creation is still queued (`false`) or has been run (`true`). */
done?: boolean;
/** The number of codes that weren't created successfully. */
failedCount?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The number of codes created successfully. */
importedCount?: boolean;
__typename?: boolean;
}>;
/** Represents a discount redeem code created by a bulk creation. */
['DiscountRedeemCodeBulkCreationCode']: AliasType<{
/** The code of a discount that is sent for creation. */
code?: boolean;
/** The discount redeem code of the successfully created code.
If the code cannot be created, the field will be null. */
discountRedeemCode?: ValueTypes['DiscountRedeemCode'];
/** A list of errors during the creation process of the code. */
errors?: ValueTypes['DiscountUserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DiscountRedeemCodeBulkCreationCodes. */
['DiscountRedeemCodeBulkCreationCodeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DiscountRedeemCodeBulkCreationCodeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DiscountRedeemCodeBulkCreationCode and a cursor during pagination. */
['DiscountRedeemCodeBulkCreationCodeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DiscountRedeemCodeBulkCreationCodeEdge. */
node?: ValueTypes['DiscountRedeemCodeBulkCreationCode'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DiscountRedeemCodes. */
['DiscountRedeemCodeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DiscountRedeemCodeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DiscountRedeemCode and a cursor during pagination. */
['DiscountRedeemCodeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DiscountRedeemCodeEdge. */
node?: ValueTypes['DiscountRedeemCode'];
__typename?: boolean;
}>;
/** Specifies the code attached to a discount. */
['DiscountRedeemCodeInput']: {
/** The code of a discount. */
code: string;
};
/** The shareable URL for the discount code. */
['DiscountShareableUrl']: AliasType<{
/** The image URL of the item (product or collection) to which the discount applies. */
targetItemImage?: ValueTypes['Image'];
/** The type of page that's associated with the URL. */
targetType?: boolean;
/** The title of the page that's associated with the URL. */
title?: boolean;
/** The URL for the discount code. */
url?: boolean;
__typename?: boolean;
}>;
/** The page type where shareable URL lands. */
['DiscountShareableUrlTargetType']: DiscountShareableUrlTargetType;
/** The selection of shipping countries to which this discount applies. */
['DiscountShippingDestinationSelection']: AliasType<{
['...on DiscountCountries']: ValueTypes['DiscountCountries'];
['...on DiscountCountryAll']: ValueTypes['DiscountCountryAll'];
__typename?: boolean;
}>;
/** Specifies the destinations where the free shipping discount will be applied. */
['DiscountShippingDestinationSelectionInput']: {
/** Whether the discount code applies to all countries. */
all?: boolean | null;
/** A list of countries where the discount code will apply. */
countries?: ValueTypes['DiscountCountriesInput'] | null;
};
/** The status of the discount. */
['DiscountStatus']: DiscountStatus;
/** The type of line a subscription discount is applied on. */
['DiscountTargetType']: DiscountTargetType;
/** The original type of the discount. */
['DiscountType']: DiscountType;
/** An error that occurs during the execution of a discount mutation. */
['DiscountUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** Extra information about this error. */
extraInfo?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Represents an error in the input of a mutation. */
['DisplayableError']: AliasType<{
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
['...on AppRevenueAttributionRecordCreateUserError']?: Omit<
ValueTypes['AppRevenueAttributionRecordCreateUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on AppRevenueAttributionRecordDeleteUserError']?: Omit<
ValueTypes['AppRevenueAttributionRecordDeleteUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on BillingAttemptUserError']?: Omit<ValueTypes['BillingAttemptUserError'], keyof ValueTypes['DisplayableError']>;
['...on BulkMutationUserError']?: Omit<ValueTypes['BulkMutationUserError'], keyof ValueTypes['DisplayableError']>;
['...on BulkProductResourceFeedbackCreateUserError']?: Omit<
ValueTypes['BulkProductResourceFeedbackCreateUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on CustomerPaymentMethodGetUpdateUrlUserError']?: Omit<
ValueTypes['CustomerPaymentMethodGetUpdateUrlUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on CustomerPaymentMethodRemoteUserError']?: Omit<ValueTypes['CustomerPaymentMethodRemoteUserError'], keyof ValueTypes['DisplayableError']>;
['...on CustomerPaymentMethodUserError']?: Omit<ValueTypes['CustomerPaymentMethodUserError'], keyof ValueTypes['DisplayableError']>;
['...on CustomerSmsMarketingConsentError']?: Omit<ValueTypes['CustomerSmsMarketingConsentError'], keyof ValueTypes['DisplayableError']>;
['...on DiscountUserError']?: Omit<ValueTypes['DiscountUserError'], keyof ValueTypes['DisplayableError']>;
['...on FilesUserError']?: Omit<ValueTypes['FilesUserError'], keyof ValueTypes['DisplayableError']>;
['...on FulfillmentOrderHoldUserError']?: Omit<ValueTypes['FulfillmentOrderHoldUserError'], keyof ValueTypes['DisplayableError']>;
['...on FulfillmentOrderReleaseHoldUserError']?: Omit<ValueTypes['FulfillmentOrderReleaseHoldUserError'], keyof ValueTypes['DisplayableError']>;
['...on FulfillmentOrderRescheduleUserError']?: Omit<ValueTypes['FulfillmentOrderRescheduleUserError'], keyof ValueTypes['DisplayableError']>;
['...on GiftCardUserError']?: Omit<ValueTypes['GiftCardUserError'], keyof ValueTypes['DisplayableError']>;
['...on MediaUserError']?: Omit<ValueTypes['MediaUserError'], keyof ValueTypes['DisplayableError']>;
['...on MetafieldDefinitionCreateUserError']?: Omit<ValueTypes['MetafieldDefinitionCreateUserError'], keyof ValueTypes['DisplayableError']>;
['...on MetafieldDefinitionDeleteUserError']?: Omit<ValueTypes['MetafieldDefinitionDeleteUserError'], keyof ValueTypes['DisplayableError']>;
['...on MetafieldDefinitionPinUserError']?: Omit<ValueTypes['MetafieldDefinitionPinUserError'], keyof ValueTypes['DisplayableError']>;
['...on MetafieldDefinitionUnpinUserError']?: Omit<ValueTypes['MetafieldDefinitionUnpinUserError'], keyof ValueTypes['DisplayableError']>;
['...on MetafieldDefinitionUpdateUserError']?: Omit<ValueTypes['MetafieldDefinitionUpdateUserError'], keyof ValueTypes['DisplayableError']>;
['...on MetafieldsSetUserError']?: Omit<ValueTypes['MetafieldsSetUserError'], keyof ValueTypes['DisplayableError']>;
['...on OrderInvoiceSendUserError']?: Omit<ValueTypes['OrderInvoiceSendUserError'], keyof ValueTypes['DisplayableError']>;
['...on PaymentTermsCreateUserError']?: Omit<ValueTypes['PaymentTermsCreateUserError'], keyof ValueTypes['DisplayableError']>;
['...on PaymentTermsDeleteUserError']?: Omit<ValueTypes['PaymentTermsDeleteUserError'], keyof ValueTypes['DisplayableError']>;
['...on PaymentTermsUpdateUserError']?: Omit<ValueTypes['PaymentTermsUpdateUserError'], keyof ValueTypes['DisplayableError']>;
['...on PriceListPriceUserError']?: Omit<ValueTypes['PriceListPriceUserError'], keyof ValueTypes['DisplayableError']>;
['...on PriceListUserError']?: Omit<ValueTypes['PriceListUserError'], keyof ValueTypes['DisplayableError']>;
['...on PriceRuleUserError']?: Omit<ValueTypes['PriceRuleUserError'], keyof ValueTypes['DisplayableError']>;
['...on ProductChangeStatusUserError']?: Omit<ValueTypes['ProductChangeStatusUserError'], keyof ValueTypes['DisplayableError']>;
['...on ProductVariantsBulkCreateUserError']?: Omit<ValueTypes['ProductVariantsBulkCreateUserError'], keyof ValueTypes['DisplayableError']>;
['...on ProductVariantsBulkDeleteUserError']?: Omit<ValueTypes['ProductVariantsBulkDeleteUserError'], keyof ValueTypes['DisplayableError']>;
['...on ProductVariantsBulkReorderUserError']?: Omit<ValueTypes['ProductVariantsBulkReorderUserError'], keyof ValueTypes['DisplayableError']>;
['...on ProductVariantsBulkUpdateUserError']?: Omit<ValueTypes['ProductVariantsBulkUpdateUserError'], keyof ValueTypes['DisplayableError']>;
['...on PubSubWebhookSubscriptionCreateUserError']?: Omit<
ValueTypes['PubSubWebhookSubscriptionCreateUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on PubSubWebhookSubscriptionUpdateUserError']?: Omit<
ValueTypes['PubSubWebhookSubscriptionUpdateUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on SellingPlanGroupUserError']?: Omit<ValueTypes['SellingPlanGroupUserError'], keyof ValueTypes['DisplayableError']>;
['...on ShopPolicyUserError']?: Omit<ValueTypes['ShopPolicyUserError'], keyof ValueTypes['DisplayableError']>;
['...on StandardMetafieldDefinitionEnableUserError']?: Omit<
ValueTypes['StandardMetafieldDefinitionEnableUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on SubscriptionContractUserError']?: Omit<ValueTypes['SubscriptionContractUserError'], keyof ValueTypes['DisplayableError']>;
['...on SubscriptionDraftUserError']?: Omit<ValueTypes['SubscriptionDraftUserError'], keyof ValueTypes['DisplayableError']>;
['...on TranslationUserError']?: Omit<ValueTypes['TranslationUserError'], keyof ValueTypes['DisplayableError']>;
['...on UrlRedirectBulkDeleteByIdsUserError']?: Omit<ValueTypes['UrlRedirectBulkDeleteByIdsUserError'], keyof ValueTypes['DisplayableError']>;
['...on UrlRedirectBulkDeleteBySavedSearchUserError']?: Omit<
ValueTypes['UrlRedirectBulkDeleteBySavedSearchUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on UrlRedirectBulkDeleteBySearchUserError']?: Omit<
ValueTypes['UrlRedirectBulkDeleteBySearchUserError'],
keyof ValueTypes['DisplayableError']
>;
['...on UrlRedirectImportUserError']?: Omit<ValueTypes['UrlRedirectImportUserError'], keyof ValueTypes['DisplayableError']>;
['...on UrlRedirectUserError']?: Omit<ValueTypes['UrlRedirectUserError'], keyof ValueTypes['DisplayableError']>;
['...on UserError']?: Omit<ValueTypes['UserError'], keyof ValueTypes['DisplayableError']>;
__typename?: boolean;
}>;
/** The possible statuses of a dispute. */
['DisputeStatus']: DisputeStatus;
/** The possible types for a dispute. */
['DisputeType']: DisputeType;
/** A unique string that represents the address of a Shopify store on the Internet. */
['Domain']: AliasType<{
/** The host name of the domain (eg: `example.com`). */
host?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The localization of the domain, if it does not redirect. */
localization?: ValueTypes['DomainLocalization'];
/** Whether SSL is enabled or not. */
sslEnabled?: boolean;
/** The URL of the domain (eg: `https://example.com`). */
url?: boolean;
__typename?: boolean;
}>;
/** The country and language settings assigned to a domain. */
['DomainLocalization']: AliasType<{
/** The ISO codes for the domain’s alternate locales. */
alternateLocales?: boolean;
/** The ISO code for the country assigned to the domain, or "*" for a domain set to "Rest of world". */
country?: boolean;
/** The ISO code for the domain’s default locale. */
defaultLocale?: boolean;
__typename?: boolean;
}>;
/** Returns unfulfilled line items grouped by their fulfillment service. Each draft fulfillment contains additional information, such as whether the fulfillment requires shipping and whether a shipping label can be printed for it. */
['DraftFulfillment']: AliasType<{
/** Whether a label can be purchased. */
allowLabelPurchase?: boolean;
/** The line items (which might correspond to a variant) that are part of this draft fulfillment. */
lineItems?: ValueTypes['LineItem'];
/** Whether a fulfillment requires shipping. */
requiresShipping?: boolean;
/** The service responsible for fulfilling the fulfillment. */
service?: ValueTypes['FulfillmentService'];
__typename?: boolean;
}>;
/** Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers.
***Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. */
['DraftOrder']: AliasType<{
/** Order-level discount applied to the draft order. */
appliedDiscount?: ValueTypes['DraftOrderAppliedDiscount'];
/** The billing address of the customer. */
billingAddress?: ValueTypes['MailingAddress'];
/** Date and time when the draft order converted to a new order,
and the draft order's status changed to **Completed**. */
completedAt?: boolean;
/** Date and time when the draft order was created in Shopify. */
createdAt?: boolean;
/** Three letter code for the currency of the store at the time that the invoice is sent. */
currencyCode?: boolean;
/** Custom information added to the draft order on behalf of your customer. */
customAttributes?: ValueTypes['Attribute'];
/** Customer who will be sent an invoice for the draft order, if there is one. */
customer?: ValueTypes['Customer'];
/** Email address of the customer, which is used to send notifications to. */
email?: boolean;
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
/** Whether the merchant has added timeline comments to the draft order. */
hasTimelineComment?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Date and time when the invoice was last emailed to the customer. */
invoiceSentAt?: boolean;
/** Link to the checkout, which is sent to your customer in the invoice email. */
invoiceUrl?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
lineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['DraftOrderLineItemConnection']
];
localizationExtensions?: [
{
/** The country codes of the extensions. */
countryCodes?: ValueTypes['CountryCode'][] /** The purpose of the extensions. */;
purposes?: ValueTypes['LocalizationExtensionPurpose'][] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['LocalizationExtensionConnection']
];
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
/** Unique identifier for the draft order, which is unique within the store. For example, _#D1223_. */
name?: boolean;
/** Text from an optional note attached to the draft order. */
note2?: boolean;
/** Order that was created from this draft order. */
order?: ValueTypes['Order'];
/** The associated payment term for this draft order. */
paymentTerms?: ValueTypes['PaymentTerms'];
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
/** Whether or not the Draft Order is ready and can be completed. Draft Orders
may have asynchronous operations that can take time to finish. */
ready?: boolean;
/** The shipping address of the customer. */
shippingAddress?: ValueTypes['MailingAddress'];
/** Line item that contains the shipping costs. */
shippingLine?: ValueTypes['ShippingLine'];
/** Status of the draft order. */
status?: boolean;
/** Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes). */
subtotalPrice?: boolean;
/** A comma separated list of tags associated with the draft order. Updating `tags` overwrites
any existing tags that were previously added to the draft order. To add new tags without overwriting
existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)
mutation. */
tags?: boolean;
/** Whether the draft order is tax exempt. */
taxExempt?: boolean;
/** Total amount of taxes charged for each line item and shipping line. */
taxLines?: ValueTypes['TaxLine'];
/** Whether the line item prices include taxes. */
taxesIncluded?: boolean;
/** Total amount of the draft order (includes taxes, shipping charges, and discounts). */
totalPrice?: boolean;
/** Total shipping charge for the draft order. */
totalShippingPrice?: boolean;
/** Total amount of taxes for the draft order. */
totalTax?: boolean;
/** Total weight (grams) of the draft order. */
totalWeight?: boolean;
/** 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?: boolean;
__typename?: boolean;
}>;
/** The order-level discount applied to a draft order. */
['DraftOrderAppliedDiscount']: AliasType<{
/** Amount of the order-level discount that is applied to the draft order. */
amount?: boolean;
/** Amount of money discounted. */
amountV2?: ValueTypes['MoneyV2'];
/** Description of the order-level discount. */
description?: boolean;
/** Name of the order-level discount. */
title?: boolean;
/** Amount of the order level discount (when value_type is percentage,
the value in this field is the percentage discount). */
value?: boolean;
/** Type of the order-level discount. */
valueType?: boolean;
__typename?: boolean;
}>;
/** The input fields for applying an order-level discount to a draft order. */
['DraftOrderAppliedDiscountInput']: {
/** The applied amount of the discount. */
amount?: ValueTypes['Money'] | null;
/** Reason for the discount. */
description?: string | null;
/** Title of the discount. */
title?: string | null;
/** The value of the discount.
If the type of the discount is fixed amount, then this is a fixed dollar amount.
If the type is percentage, then this is the percentage. */
value: number;
/** The type of discount. */
valueType: ValueTypes['DraftOrderAppliedDiscountType'];
};
/** The valid discount types that can be applied to a draft order. */
['DraftOrderAppliedDiscountType']: DraftOrderAppliedDiscountType;
/** Return type for `draftOrderCalculate` mutation. */
['DraftOrderCalculatePayload']: AliasType<{
/** The calculated properties for a draft order. */
calculatedDraftOrder?: ValueTypes['CalculatedDraftOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `draftOrderComplete` mutation. */
['DraftOrderCompletePayload']: AliasType<{
/** The completed draft order. */
draftOrder?: ValueTypes['DraftOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DraftOrders. */
['DraftOrderConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DraftOrderEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `draftOrderCreate` mutation. */
['DraftOrderCreatePayload']: AliasType<{
/** The created draft order. */
draftOrder?: ValueTypes['DraftOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the draft order to delete by its ID. */
['DraftOrderDeleteInput']: {
/** The ID of the draft order to delete. */
id: string;
};
/** Return type for `draftOrderDelete` mutation. */
['DraftOrderDeletePayload']: AliasType<{
/** The ID of the deleted draft order. */
deletedId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DraftOrder and a cursor during pagination. */
['DraftOrderEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DraftOrderEdge. */
node?: ValueTypes['DraftOrder'];
__typename?: boolean;
}>;
/** The input fields used to create or update a draft order. */
['DraftOrderInput']: {
/** The discount that will be applied to the draft order.
A draft order line item can have one discount. A draft order can also have one order-level discount. */
appliedDiscount?: ValueTypes['DraftOrderAppliedDiscountInput'] | null;
/** The mailing address associated with the payment method. */
billingAddress?: ValueTypes['MailingAddressInput'] | null;
/** Customer associated with the draft order. */
customerId?: string | null;
/** Extra information added to the customer. */
customAttributes?: ValueTypes['AttributeInput'][];
/** The customer's email address. */
email?: string | null;
/** Product variant line item or custom line item associated to the draft order.
Each draft order must include at least one line item. */
lineItems?: ValueTypes['DraftOrderLineItemInput'][];
/** Metafields attached to the draft order. */
metafields?: ValueTypes['MetafieldInput'][];
/** The private metafields attached to the draft order. */
privateMetafields?: ValueTypes['PrivateMetafieldInput'][];
/** The localization extensions attached to the draft order. For example, Tax IDs. */
localizationExtensions?: ValueTypes['LocalizationExtensionInput'][];
/** The text of an optional note that a shop owner can attach to the draft order. */
note?: string | null;
/** The mailing address to where the order will be shipped. */
shippingAddress?: ValueTypes['MailingAddressInput'] | null;
/** A shipping line object, which details the shipping method used. */
shippingLine?: ValueTypes['ShippingLineInput'] | null;
/** A comma separated list of tags that have been added to the draft order. */
tags?: string[];
/** Whether or not taxes are exempt for the draft order.
If false, then Shopify will refer to the taxable field for each line item.
If a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead. */
taxExempt?: boolean | null;
/** Sent as part of a draft order object to load customer shipping information. */
useCustomerDefaultAddress?: boolean | null;
/** The fields used to create payment terms. */
paymentTerms?: ValueTypes['PaymentTermsInput'] | null;
};
/** Return type for `draftOrderInvoicePreview` mutation. */
['DraftOrderInvoicePreviewPayload']: AliasType<{
/** HTML to preview the draft order invoice email. */
previewHtml?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `draftOrderInvoiceSend` mutation. */
['DraftOrderInvoiceSendPayload']: AliasType<{
/** The draft order an invoice email is sent for. */
draftOrder?: ValueTypes['DraftOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents a line item included in a draft order. */
['DraftOrderLineItem']: AliasType<{
/** Discount which will be applied to the line item or the overall order. */
appliedDiscount?: ValueTypes['DraftOrderAppliedDiscount'];
/** Whether this is a product variant line item, or a custom line item.
If set to true indicates a custom line item. If set to false indicates a product variant line item. */
custom?: boolean;
/** List of additional information about the line item. */
customAttributes?: ValueTypes['Attribute'];
/** Line item price after discounts are applied. */
discountedTotal?: boolean;
/** The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit. */
discountedUnitPrice?: boolean;
/** Name of the service provider who fulfilled the order.
Valid values are either **manual** or the name of the provider.
For example, **amazon**, **shipwire**.
Deleted fulfillment services will return null. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** Weight in grams. Can only be specified if this is a custom line item. */
grams?: boolean;
/** A globally-unique identifier. */
id?: boolean;
image?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** Whether the line item represents the puchase of a gift card. */
isGiftCard?: boolean;
/** Name of the product. */
name?: boolean;
/** Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. */
originalTotal?: boolean;
/** Variant price without any discounts applied. */
originalUnitPrice?: boolean;
/** The product corresponding to the line item’s product variant. */
product?: ValueTypes['Product'];
/** Number of variant items requested in the draft order. */
quantity?: boolean;
/** Whether physical shipping is required for the variant. */
requiresShipping?: boolean;
/** Variant SKU number. */
sku?: boolean;
/** A list of tax line objects, each of which details the total taxes applicable to the order. */
taxLines?: ValueTypes['TaxLine'];
/** Whether the variant is taxable. */
taxable?: boolean;
/** Title of the product or variant (this field only applies to custom line items). */
title?: boolean;
/** Total value of the discount applied to the line item. */
totalDiscount?: boolean;
/** Associated variant for the line item. */
variant?: ValueTypes['ProductVariant'];
/** Name of the variant. */
variantTitle?: boolean;
/** Name of the vendor who made the variant. */
vendor?: boolean;
/** Weight unit and value for a draft order line item. */
weight?: ValueTypes['Weight'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple DraftOrderLineItems. */
['DraftOrderLineItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['DraftOrderLineItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination. */
['DraftOrderLineItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of DraftOrderLineItemEdge. */
node?: ValueTypes['DraftOrderLineItem'];
__typename?: boolean;
}>;
/** The input fields used to create a line item for a draft order. */
['DraftOrderLineItemInput']: {
/** Discount which will be applied to the line item. */
appliedDiscount?: ValueTypes['DraftOrderAppliedDiscountInput'] | null;
/** Represents a generic custom attribute using a key value pair. */
customAttributes?: ValueTypes['AttributeInput'][];
/** The weight in grams. This value is ignored when `variantId` is provided. This argument is deprecated: Use `weight` instead. */
grams?: number | null;
/** The price without any discounts applied. This value is ignored when `variantId` is provided. */
originalUnitPrice?: ValueTypes['Money'] | null;
/** The number of products that were purchased. */
quantity: number;
/** Whether physical shipping is required. This value is ignored when `variantId` is provided. */
requiresShipping?: boolean | null;
/** The SKU number of the item. This value is ignored when `variantId` is provided. */
sku?: string | null;
/** Whether the item is taxable. This value is ignored when `variantId` is provided. */
taxable?: boolean | null;
/** Title of the item. Ignored when `variantId` is provided. */
title?: string | null;
/** The ID of the product variant corresponding to the line item.
Null if custom line item. Required if product variant line item. */
variantId?: string | null;
/** Specifies the weight unit and value inputs.
This value is ignored when `variantId` is provided. */
weight?: ValueTypes['WeightInput'] | null;
};
/** The set of valid sort keys for the DraftOrder query. */
['DraftOrderSortKeys']: DraftOrderSortKeys;
/** The valid statuses for a draft order. */
['DraftOrderStatus']: DraftOrderStatus;
/** Return type for `draftOrderUpdate` mutation. */
['DraftOrderUpdatePayload']: AliasType<{
/** The updated draft order. */
draftOrder?: ValueTypes['DraftOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The duty details for a line item. */
['Duty']: AliasType<{
/** The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty. */
countryCodeOfOrigin?: boolean;
/** The harmonized system code of the item used in calculating the duty. */
harmonizedSystemCode?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The amount of the duty. */
price?: ValueTypes['MoneyBag'];
/** A list of taxes charged on the duty. */
taxLines?: ValueTypes['TaxLine'];
__typename?: boolean;
}>;
/** A sale associated with a duty charge. */
['DutySale']: AliasType<{
/** The type of order action that the sale represents. */
actionType?: boolean;
/** The duty for the associated sale. */
duty?: ValueTypes['Duty'];
/** The unique identifier for the sale. */
id?: boolean;
/** The line type assocated with the sale. */
lineType?: boolean;
/** The number of units either ordered or intended to be returned. */
quantity?: boolean;
/** All individual taxes associated with the sale. */
taxes?: ValueTypes['SaleTax'];
/** The total sale amount after taxes and discounts. */
totalAmount?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale after taxes. */
totalDiscountAmountAfterTaxes?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale before taxes. */
totalDiscountAmountBeforeTaxes?: ValueTypes['MoneyBag'];
/** The total amount of taxes for the sale. */
totalTaxAmount?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** The attribute editable information. */
['EditableProperty']: AliasType<{
/** Whether the attribute is locked for editing. */
locked?: boolean;
/** The reason the attribute is locked for editing. */
reason?: boolean;
__typename?: boolean;
}>;
/** Specifies the fields for an email. */
['EmailInput']: {
/** Specifies the email subject. */
subject?: string | null;
/** Specifies the email recipient. */
to?: string | null;
/** Specifies the email sender. */
from?: string | null;
/** Specifies the email body. */
body?: string | null;
/** Specifies any bcc recipients for the email. */
bcc?: string[];
/** Specifies a custom message to include in the email. */
customMessage?: string | null;
};
/** Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the
addition of a product. */
['Event']: AliasType<{
/** The name of the app that created the event. */
appTitle?: boolean;
/** Whether the event was created by an app. */
attributeToApp?: boolean;
/** Whether the event was caused by an admin user. */
attributeToUser?: boolean;
/** The date and time when the event was created. */
createdAt?: boolean;
/** Whether the event is critical. */
criticalAlert?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Human readable text that describes the event. */
message?: boolean;
['...on BasicEvent']?: Omit<ValueTypes['BasicEvent'], keyof ValueTypes['Event']>;
['...on CommentEvent']?: Omit<ValueTypes['CommentEvent'], keyof ValueTypes['Event']>;
__typename?: boolean;
}>;
/** Return type for `eventBridgeWebhookSubscriptionCreate` mutation. */
['EventBridgeWebhookSubscriptionCreatePayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
/** The webhook subscription that was created. */
webhookSubscription?: ValueTypes['WebhookSubscription'];
__typename?: boolean;
}>;
/** Specifies the input fields for an EventBridge webhook subscription. */
['EventBridgeWebhookSubscriptionInput']: {
/** The ARN of the EventBridge partner event source. */
arn?: ValueTypes['ARN'] | null;
/** The format in which the webhook subscription should send the data. */
format?: ValueTypes['WebhookSubscriptionFormat'] | null;
/** The list of fields to be included in the webhook subscription. */
includeFields?: string[];
/** The list of namespaces for any metafields that should be included in the webhook subscription. */
metafieldNamespaces?: string[];
};
/** Return type for `eventBridgeWebhookSubscriptionUpdate` mutation. */
['EventBridgeWebhookSubscriptionUpdatePayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
/** The webhook subscription that was updated. */
webhookSubscription?: ValueTypes['WebhookSubscription'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Events. */
['EventConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['EventEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Event and a cursor during pagination. */
['EventEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of EventEdge. */
node?: ValueTypes['Event'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the Event query. */
['EventSortKeys']: EventSortKeys;
/** Represents a video hosted outside of Shopify. */
['ExternalVideo']: AliasType<{
/** A word or phrase to share the nature or contents of a media. */
alt?: boolean;
/** The URL. */
embeddedUrl?: boolean;
/** The host of the external video. */
host?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The media content type. */
mediaContentType?: boolean;
/** Any errors which have occurred on the media. */
mediaErrors?: ValueTypes['MediaError'];
/** The warnings attached to the media. */
mediaWarnings?: ValueTypes['MediaWarning'];
/** The preview image for the media. */
preview?: ValueTypes['MediaPreviewImage'];
/** Current status of the media. */
status?: boolean;
__typename?: boolean;
}>;
/** Requirements that must be met before an app can be installed. */
['FailedRequirement']: AliasType<{
/** Action to be taken to resolve a failed requirement, including URL link. */
action?: ValueTypes['NavigationItem'];
/** A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app
encounters when trying to make use of their Shop and its resources. */
message?: boolean;
__typename?: boolean;
}>;
/** A file interface. */
['File']: AliasType<{
/** A word or phrase to describe the contents or the function of a file. */
alt?: boolean;
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created. */
createdAt?: boolean;
/** Any errors that have occurred on the file. */
fileErrors?: ValueTypes['FileError'];
/** The status of the file. */
fileStatus?: boolean;
/** The preview image for the media. */
preview?: ValueTypes['MediaPreviewImage'];
['...on GenericFile']?: Omit<ValueTypes['GenericFile'], keyof ValueTypes['File']>;
['...on MediaImage']?: Omit<ValueTypes['MediaImage'], keyof ValueTypes['File']>;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Files. */
['FileConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FileEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** The possible content types for a file object. */
['FileContentType']: FileContentType;
/** The input fields that are required to create a file object. */
['FileCreateInput']: {
/** An external URL or a signed upload URL of the file object. */
originalSource: string;
/** The file content type. */
contentType?: ValueTypes['FileContentType'] | null;
/** The alt text associated with the file. */
alt?: string | null;
};
/** Return type for `fileCreate` mutation. */
['FileCreatePayload']: AliasType<{
/** The newly created files. */
files?: ValueTypes['File'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['FilesUserError'];
__typename?: boolean;
}>;
/** Return type for `fileDelete` mutation. */
['FileDeletePayload']: AliasType<{
/** The IDs of the deleted files. */
deletedFileIds?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['FilesUserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one File and a cursor during pagination. */
['FileEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FileEdge. */
node?: ValueTypes['File'];
__typename?: boolean;
}>;
/** A file error. */
['FileError']: AliasType<{
/** Code representing the type of error. */
code?: boolean;
/** Additional details regarding the error. */
details?: boolean;
/** Translated error message. */
message?: boolean;
__typename?: boolean;
}>;
/** The error types for a file. */
['FileErrorCode']: FileErrorCode;
/** The set of valid sort keys for the File query. */
['FileSortKeys']: FileSortKeys;
/** The possible statuses for a file object. */
['FileStatus']: FileStatus;
/** The input fields that are required to update a file object. */
['FileUpdateInput']: {
/** The file to update. */
id: string;
/** The alt text associated with the file. */
alt?: string | null;
};
/** Return type for `fileUpdate` mutation. */
['FileUpdatePayload']: AliasType<{
/** The list of updated files. */
files?: ValueTypes['File'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['FilesUserError'];
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `FilesUserError`. */
['FilesErrorCode']: FilesErrorCode;
/** An error that happens during the execution of a Files API query or mutation. */
['FilesUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** A filter option is one possible value in a search filter. */
['FilterOption']: AliasType<{
/** The filter option's label for display purposes. */
label?: boolean;
/** The filter option's value. */
value?: boolean;
__typename?: boolean;
}>;
/** Return type for `flowTriggerReceive` mutation. */
['FlowTriggerReceivePayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** A string containing a strict subset of HTML code. Non-allowed tags will be stripped out.
Allowed tags:
* `a` (allowed attributes: `href`)
* `b`
* `br`
* `em`
* `i`
* `strong`
* `u`
Use [HTML](https://shopify.dev/api/admin-graphql/latest/scalars/HTML) instead if you need to
include other HTML tags.
Example value: `"Your current domain is <strong>johns-apparel.myshopify.com</strong>."` */
['FormattedString']: unknown;
/** Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order. */
['Fulfillment']: AliasType<{
/** The date and time when the fulfillment was created. */
createdAt?: boolean;
/** The date that this fulfillment was delivered. */
deliveredAt?: boolean;
/** Human readable display status for this fulfillment. */
displayStatus?: boolean;
/** The estimated date that this fulfillment will arrive. */
estimatedDeliveryAt?: boolean;
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['FulfillmentEventSortKeys'] | null;
},
ValueTypes['FulfillmentEventConnection']
];
fulfillmentLineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['FulfillmentLineItemConnection']
];
fulfillmentOrders?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['FulfillmentOrderConnection']
];
/** A globally-unique identifier. */
id?: boolean;
/** The date and time when the fulfillment went into transit. */
inTransitAt?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The location that the fulfillment was processed at. */
location?: ValueTypes['Location'];
/** Human readable reference identifier for this fulfillment. */
name?: boolean;
/** The order for which the fulfillment was created. */
order?: ValueTypes['Order'];
/** The address at which the fulfillment occurred. Typically this is the address of the warehouse or fulfillment center. */
originAddress?: ValueTypes['FulfillmentOriginAddress'];
/** Whether any of the line items in the fulfillment require shipping. */
requiresShipping?: boolean;
/** Fulfillment service associated with the fulfillment. */
service?: ValueTypes['FulfillmentService'];
/** The status of the fulfillment. */
status?: boolean;
/** Sum of all line item quantities for the fulfillment. */
totalQuantity?: boolean;
trackingInfo?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['FulfillmentTrackingInfo']
];
/** The date and time when the fulfillment was last modified. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** Return type for `fulfillmentCancel` mutation. */
['FulfillmentCancelPayload']: AliasType<{
/** The canceled fulfillment. */
fulfillment?: ValueTypes['Fulfillment'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Fulfillments. */
['FulfillmentConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FulfillmentEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentCreate` mutation. */
['FulfillmentCreatePayload']: AliasType<{
/** The created fulfillment. */
fulfillment?: ValueTypes['Fulfillment'];
/** The order for which the fulfillment is created. */
order?: ValueTypes['Order'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentCreateV2` mutation. */
['FulfillmentCreateV2Payload']: AliasType<{
/** The created fulfillment. */
fulfillment?: ValueTypes['Fulfillment'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The display status of a fulfillment. */
['FulfillmentDisplayStatus']: FulfillmentDisplayStatus;
/** An auto-generated type which holds one Fulfillment and a cursor during pagination. */
['FulfillmentEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FulfillmentEdge. */
node?: ValueTypes['Fulfillment'];
__typename?: boolean;
}>;
/** The fulfillment event that describes the fulfilllment status at a particular time. */
['FulfillmentEvent']: AliasType<{
/** The time at which this fulfillment event happened. */
happenedAt?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The status of this fulfillment event. */
status?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple FulfillmentEvents. */
['FulfillmentEventConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FulfillmentEventEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one FulfillmentEvent and a cursor during pagination. */
['FulfillmentEventEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FulfillmentEventEdge. */
node?: ValueTypes['FulfillmentEvent'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the FulfillmentEvent query. */
['FulfillmentEventSortKeys']: FulfillmentEventSortKeys;
/** The status that describes a fulfillment or delivery event. */
['FulfillmentEventStatus']: FulfillmentEventStatus;
/** A fulfillment hold currently applied on a fulfillment order. */
['FulfillmentHold']: AliasType<{
/** The reason for the fulfillment hold. */
reason?: boolean;
/** Additional information about the fulfillment hold reason. */
reasonNotes?: boolean;
__typename?: boolean;
}>;
/** The reason for a fulfillment hold. */
['FulfillmentHoldReason']: FulfillmentHoldReason;
/** The input fields used to create a fulfillment. */
['FulfillmentInput']: {
/** The ID of the order to be fulfilled. */
orderId: string;
/** The order line items to be fulfilled. */
lineItems?: ValueTypes['FulfillmentLineItemInput'][];
/** Tracking numbers associated with the fulfillment. */
trackingNumbers?: string[];
/** The URLs to track the fulfillment. */
trackingUrls?: string[];
/** The name of the tracking company. */
trackingCompany?: string | null;
/** Whether the customer is notified when the fulfillment is created.
If `true`, then a notification is sent when the fulfillment is created. */
notifyCustomer?: boolean | null;
/** A reference to the [ShippingMethod](https://shopify.dev/api/admin-graphql/latest/objects/shippingmethod) code, for example `FREE_SHIPPING`. */
shippingMethod?: string | null;
/** The ID of the location from which the line items will be fulfilled. */
locationId: string;
/** The address at which the fulfillment occurred.
Typically this is the address of a warehouse or a fulfillment center. */
originAddress?: ValueTypes['FulfillmentOriginAddressInput'] | null;
};
/** Represents a line item from an order that's included in a fulfillment. */
['FulfillmentLineItem']: AliasType<{
/** The total price after discounts are applied. */
discountedTotal?: boolean;
/** The total price after discounts are applied in shop and presentment currencies. */
discountedTotalSet?: ValueTypes['MoneyBag'];
/** A globally-unique identifier. */
id?: boolean;
/** The associated order's line item. */
lineItem?: ValueTypes['LineItem'];
/** The total price before discounts are applied. */
originalTotal?: boolean;
/** The total price before discounts are applied in shop and presentment currencies. */
originalTotalSet?: ValueTypes['MoneyBag'];
/** Number of line items in the fulfillment. */
quantity?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple FulfillmentLineItems. */
['FulfillmentLineItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FulfillmentLineItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. */
['FulfillmentLineItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FulfillmentLineItemEdge. */
node?: ValueTypes['FulfillmentLineItem'];
__typename?: boolean;
}>;
/** The input fields used to include a line item from an order in a fulfillment. */
['FulfillmentLineItemInput']: {
/** The ID of the line item. */
id: string;
/** The quantity of the line item to be fulfilled. */
quantity?: number | null;
};
/** Represents a fulfillment order. In Shopify, a fulfillment order represents a group of one or more items
in an order that are to be fulfilled from the same location. There can be more than one fulfillment order
for an order at a given location. */
['FulfillmentOrder']: AliasType<{
/** The fulfillment order's assigned location. This is the location expected to perform fulfillment. */
assignedLocation?: ValueTypes['FulfillmentOrderAssignedLocation'];
/** Delivery method of this fulfillment order. */
deliveryMethod?: ValueTypes['DeliveryMethod'];
/** The destination where the items should be sent. */
destination?: ValueTypes['FulfillmentOrderDestination'];
/** The date and time at which the fulfillment order will be fulfillable. */
fulfillAt?: boolean;
/** The fulfillment holds applied on the fulfillment order. */
fulfillmentHolds?: ValueTypes['FulfillmentHold'];
fulfillments?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['FulfillmentConnection']
];
/** A globally-unique identifier. */
id?: boolean;
/** The duties delivery method of this fulfillment order. */
internationalDuties?: ValueTypes['FulfillmentOrderInternationalDuties'];
lineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['FulfillmentOrderLineItemConnection']
];
locationsForMove?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['FulfillmentOrderLocationForMoveConnection']
];
merchantRequests?: [
{
/** The kind of request the merchant sent. */
kind?: ValueTypes['FulfillmentOrderMerchantRequestKind'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['FulfillmentOrderMerchantRequestConnection']
];
/** The order that's associated with the fulfillment order. */
order?: ValueTypes['Order'];
/** The request status of the fulfillment order. */
requestStatus?: boolean;
/** The status of the fulfillment order. */
status?: boolean;
/** The actions that can be performed on this fulfillment order. */
supportedActions?: ValueTypes['FulfillmentOrderSupportedAction'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderAcceptCancellationRequest` mutation. */
['FulfillmentOrderAcceptCancellationRequestPayload']: AliasType<{
/** The fulfillment order whose cancellation request was accepted. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderAcceptFulfillmentRequest` mutation. */
['FulfillmentOrderAcceptFulfillmentRequestPayload']: AliasType<{
/** The fulfillment order whose fulfillment request was accepted. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The actions that can be taken on a fulfillment order. */
['FulfillmentOrderAction']: FulfillmentOrderAction;
/** Represents the assigned location of a fulfillment order, which is a snapshot of the location
at which the fulfillment order was created. The assigned location is expected to perform fulfillment. */
['FulfillmentOrderAssignedLocation']: AliasType<{
/** The first line of the address for the location. */
address1?: boolean;
/** The second line of the address for the location. */
address2?: boolean;
/** The city of the location. */
city?: boolean;
/** The two-letter country code of the location. */
countryCode?: boolean;
/** The location where the fulfillment order was created. This can differ from the
`FulfillmentOrderAssignedLocation` if the location was updated since the fulfillment order
was closed. */
location?: ValueTypes['Location'];
/** The name of the location. */
name?: boolean;
/** The phone number of the location. */
phone?: boolean;
/** The province of the location. */
province?: boolean;
/** The ZIP code of the location. */
zip?: boolean;
__typename?: boolean;
}>;
/** The assigment status to be used to filter fulfillment orders. */
['FulfillmentOrderAssignmentStatus']: FulfillmentOrderAssignmentStatus;
/** Return type for `fulfillmentOrderCancel` mutation. */
['FulfillmentOrderCancelPayload']: AliasType<{
/** The fulfillment order that was marked as canceled. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The fulfillment order that was created to replace the canceled fulfillment order. */
replacementFulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderClose` mutation. */
['FulfillmentOrderClosePayload']: AliasType<{
/** The fulfillment order that was marked as incomplete. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple FulfillmentOrders. */
['FulfillmentOrderConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FulfillmentOrderEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Represents the destination where the items should be sent upon fulfillment. */
['FulfillmentOrderDestination']: AliasType<{
/** The first line of the address of the destination. */
address1?: boolean;
/** The second line of the address of the destination. */
address2?: boolean;
/** The city of the destination. */
city?: boolean;
/** The company of the destination. */
company?: boolean;
/** The two-letter country code of the destination. */
countryCode?: boolean;
/** The email of the customer at the destination. */
email?: boolean;
/** The first name of the customer at the destination. */
firstName?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The last name of the customer at the destination. */
lastName?: boolean;
/** The phone number of the customer at the destination. */
phone?: boolean;
/** The province of the destination. */
province?: boolean;
/** The ZIP code of the destination. */
zip?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type which holds one FulfillmentOrder and a cursor during pagination. */
['FulfillmentOrderEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FulfillmentOrderEdge. */
node?: ValueTypes['FulfillmentOrder'];
__typename?: boolean;
}>;
/** Input arguments for the fulfillment hold applied on the fulfillment order. */
['FulfillmentOrderHoldInput']: {
/** The reason for the fulfillment hold. */
reason: ValueTypes['FulfillmentHoldReason'];
/** Additional information about the fulfillment hold reason. */
reasonNotes?: string | null;
/** Whether the merchant receives a notification about the fulfillment hold. The default value is `false`. */
notifyMerchant?: boolean | null;
};
/** Return type for `fulfillmentOrderHold` mutation. */
['FulfillmentOrderHoldPayload']: AliasType<{
/** The fulfillment order on which a fulfillment hold was applied. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['FulfillmentOrderHoldUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `FulfillmentOrderHold`. */
['FulfillmentOrderHoldUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `FulfillmentOrderHoldUserError`. */
['FulfillmentOrderHoldUserErrorCode']: FulfillmentOrderHoldUserErrorCode;
/** The international duties relevant to a fulfillment order. */
['FulfillmentOrderInternationalDuties']: AliasType<{
/** The method of duties payment. Example values: `DDP`, `DAP`. */
incoterm?: boolean;
__typename?: boolean;
}>;
/** Represents a line item belonging to a fulfillment order. */
['FulfillmentOrderLineItem']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The associated order line item. */
lineItem?: ValueTypes['LineItem'];
/** The number of units remaining to be fulfilled. */
remainingQuantity?: boolean;
/** The total number of units to be fulfilled. */
totalQuantity?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple FulfillmentOrderLineItems. */
['FulfillmentOrderLineItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FulfillmentOrderLineItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one FulfillmentOrderLineItem and a cursor during pagination. */
['FulfillmentOrderLineItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FulfillmentOrderLineItemEdge. */
node?: ValueTypes['FulfillmentOrderLineItem'];
__typename?: boolean;
}>;
/** The input fields used to include the quantity of the fulfillment order line item that should be fulfilled. */
['FulfillmentOrderLineItemInput']: {
/** The ID of the fulfillment order line item. */
id: string;
/** The quantity of the fulfillment order line item. */
quantity: number;
};
/** The input fields used to include the line items of a specified fulfillment order that should be fulfilled. */
['FulfillmentOrderLineItemsInput']: {
/** The ID of the fulfillment order. */
fulfillmentOrderId: string;
/** The fulfillment order line items to be fulfilled.
If left blank, all line items of the fulfillment order will be fulfilled. */
fulfillmentOrderLineItems?: ValueTypes['FulfillmentOrderLineItemInput'][];
};
/** A location that a fulfillment order can potentially move to. */
['FulfillmentOrderLocationForMove']: AliasType<{
/** The location being considered as the fulfillment order's new assigned location. */
location?: ValueTypes['Location'];
/** A human-readable string with the reason why the fulfillment order, or some of its line items, can't be
moved to the location. */
message?: boolean;
/** Whether the fulfillment order can be moved to the location. */
movable?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple FulfillmentOrderLocationForMoves. */
['FulfillmentOrderLocationForMoveConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FulfillmentOrderLocationForMoveEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one FulfillmentOrderLocationForMove and a cursor during pagination. */
['FulfillmentOrderLocationForMoveEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FulfillmentOrderLocationForMoveEdge. */
node?: ValueTypes['FulfillmentOrderLocationForMove'];
__typename?: boolean;
}>;
/** Represents a request made by the merchant to a fulfillment service for a fulfillment order. */
['FulfillmentOrderMerchantRequest']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The kind of request made. */
kind?: boolean;
/** The optional message that the merchant included in the request. */
message?: boolean;
/** Additional options requested by the merchant. These depend on the `kind` of the request.
For example, for a `FULFILLMENT_REQUEST`, one option is `notify_customer`, which indicates whether the
merchant intends to notify the customer upon fulfillment. The fulfillment service can then set
`notifyCustomer` when making calls to `FulfillmentCreateV2`. */
requestOptions?: boolean;
/** The response from the fulfillment service. */
responseData?: boolean;
/** The timestamp when the request was made. */
sentAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple FulfillmentOrderMerchantRequests. */
['FulfillmentOrderMerchantRequestConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['FulfillmentOrderMerchantRequestEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one FulfillmentOrderMerchantRequest and a cursor during pagination. */
['FulfillmentOrderMerchantRequestEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of FulfillmentOrderMerchantRequestEdge. */
node?: ValueTypes['FulfillmentOrderMerchantRequest'];
__typename?: boolean;
}>;
/** The kinds of request merchants can make to a fulfillment service. */
['FulfillmentOrderMerchantRequestKind']: FulfillmentOrderMerchantRequestKind;
/** Return type for `fulfillmentOrderMove` mutation. */
['FulfillmentOrderMovePayload']: AliasType<{
/** A new fulfillment order representing of the all line items that were moved to the new location. */
movedFulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The fulfillment order that was moved. On success, this fulfillment order will be closed. */
originalFulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** A new fulfillment order representing the remaining line items that are still assigned to the original
location. This field is returned when any line items on the original fulfillment order can't be moved
because they are are not stocked at the new location. */
remainingFulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderOpen` mutation. */
['FulfillmentOrderOpenPayload']: AliasType<{
/** The fulfillment order that was transitioned to open and is fulfillable. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderRejectCancellationRequest` mutation. */
['FulfillmentOrderRejectCancellationRequestPayload']: AliasType<{
/** The fulfillment order whose cancellation request was rejected. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderRejectFulfillmentRequest` mutation. */
['FulfillmentOrderRejectFulfillmentRequestPayload']: AliasType<{
/** The fulfillment order whose fulfillment request was rejected. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderReleaseHold` mutation. */
['FulfillmentOrderReleaseHoldPayload']: AliasType<{
/** The fulfillment order on which the hold was released. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['FulfillmentOrderReleaseHoldUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `FulfillmentOrderReleaseHold`. */
['FulfillmentOrderReleaseHoldUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `FulfillmentOrderReleaseHoldUserError`. */
['FulfillmentOrderReleaseHoldUserErrorCode']: FulfillmentOrderReleaseHoldUserErrorCode;
/** The request status of a fulfillment order. */
['FulfillmentOrderRequestStatus']: FulfillmentOrderRequestStatus;
/** Return type for `fulfillmentOrderReschedule` mutation. */
['FulfillmentOrderReschedulePayload']: AliasType<{
/** The fulfillment order that was rescheduled. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['FulfillmentOrderRescheduleUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `FulfillmentOrderReschedule`. */
['FulfillmentOrderRescheduleUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `FulfillmentOrderRescheduleUserError`. */
['FulfillmentOrderRescheduleUserErrorCode']: FulfillmentOrderRescheduleUserErrorCode;
/** The set of valid sort keys for the FulfillmentOrder query. */
['FulfillmentOrderSortKeys']: FulfillmentOrderSortKeys;
/** The status of a fulfillment order. */
['FulfillmentOrderStatus']: FulfillmentOrderStatus;
/** Return type for `fulfillmentOrderSubmitCancellationRequest` mutation. */
['FulfillmentOrderSubmitCancellationRequestPayload']: AliasType<{
/** The fulfillment order specified in the cancelation request. */
fulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentOrderSubmitFulfillmentRequest` mutation. */
['FulfillmentOrderSubmitFulfillmentRequestPayload']: AliasType<{
/** The original fulfillment order intended to request fulfillment for. */
originalFulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The fulfillment order that was submitted to the fulfillment service. This will be the same as
the original fulfillment order field. The exception to this is partial fulfillment requests or
fulfillment request for cancelled or incomplete fulfillment orders. */
submittedFulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** This field will only be present for partial fulfillment requests. This will represent the new
fulfillment order with the remaining line items not submitted to the fulfillment service. */
unsubmittedFulfillmentOrder?: ValueTypes['FulfillmentOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** One of the actions that the fulfillment order supports in its current state. */
['FulfillmentOrderSupportedAction']: AliasType<{
/** The action value. */
action?: boolean;
/** The external URL to be used to initiate the fulfillment process outside Shopify.
Applicable only when the `action` value is `EXTERNAL`. */
externalUrl?: boolean;
__typename?: boolean;
}>;
/** The address at which the fulfillment occurred. Typically this is the address of the warehouse or fulfillment center. */
['FulfillmentOriginAddress']: AliasType<{
/** The street address of the fulfillment location. */
address1?: boolean;
/** The second line of the address. Typically the number of the apartment, suite, or unit. */
address2?: boolean;
/** The city in which the fulfillment location is located. */
city?: boolean;
/** The country code of the fulfillment location. */
countryCode?: boolean;
/** The province code of the fulfillment location. */
provinceCode?: boolean;
/** The zip code of the fulfillment location. */
zip?: boolean;
__typename?: boolean;
}>;
/** The input fields used to include the address at which the fulfillment occurred. Typically the address of a warehouse or a fulfillment center. */
['FulfillmentOriginAddressInput']: {
/** The street address of the fulfillment location. */
address1?: string | null;
/** The second line of the address. Typically the number of the apartment, suite, or unit. */
address2?: string | null;
/** The city in which the fulfillment location is located. */
city?: string | null;
/** The zip code of the fulfillment location. */
zip?: string | null;
/** The province of the fulfillment location. */
provinceCode?: string | null;
/** The country of the fulfillment location. */
countryCode: string;
};
/** Represents a fulfillment service. A fulfillment service is a third-party service that prepares and ships orders on behalf of the store owner. */
['FulfillmentService']: AliasType<{
/** The callback URL the fulfillment service has registered for requests. */
callbackUrl?: boolean;
/** Whether the fulfillment service has opted into fulfillment order based requests. */
fulfillmentOrdersOptIn?: boolean;
/** Human-readable unique identifier for this fulfillment service. */
handle?: boolean;
/** The ID of the fulfillment service. */
id?: boolean;
/** Whether the fulfillment service tracks product inventory and provides updates to Shopify. */
inventoryManagement?: boolean;
/** Location associated with the fulfillment service. */
location?: ValueTypes['Location'];
/** Whether the fulfillment service supports local deliveries. */
productBased?: boolean;
/** The name of the fulfillment service as seen by merchants. */
serviceName?: boolean;
/** Shipping methods associated with the fulfillment service provider. */
shippingMethods?: ValueTypes['ShippingMethod'];
/** Type associated with the fulfillment service. */
type?: boolean;
__typename?: boolean;
}>;
/** Return type for `fulfillmentServiceCreate` mutation. */
['FulfillmentServiceCreatePayload']: AliasType<{
/** The created fulfillment service. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentServiceDelete` mutation. */
['FulfillmentServiceDeletePayload']: AliasType<{
/** The ID of the deleted fulfillment service. */
deletedId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The type of a fulfillment service. */
['FulfillmentServiceType']: FulfillmentServiceType;
/** Return type for `fulfillmentServiceUpdate` mutation. */
['FulfillmentServiceUpdatePayload']: AliasType<{
/** The updated fulfillment service. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The status of a fulfillment. */
['FulfillmentStatus']: FulfillmentStatus;
/** Represents the tracking information for a fulfillment. */
['FulfillmentTrackingInfo']: AliasType<{
/** The name of the tracking company. */
company?: boolean;
/** The tracking number of the fulfillment. */
number?: boolean;
/** The URLs to track the fulfillment. */
url?: boolean;
__typename?: boolean;
}>;
/** Return type for `fulfillmentTrackingInfoUpdate` mutation. */
['FulfillmentTrackingInfoUpdatePayload']: AliasType<{
/** The updated fulfillment with tracking information. */
fulfillment?: ValueTypes['Fulfillment'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `fulfillmentTrackingInfoUpdateV2` mutation. */
['FulfillmentTrackingInfoUpdateV2Payload']: AliasType<{
/** The updated fulfillment with tracking information. */
fulfillment?: ValueTypes['Fulfillment'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The input fields that specify all possible fields for tracking information. */
['FulfillmentTrackingInput']: {
/** The tracking number of the fulfillment. */
number?: string | null;
/** The URL to track the fulfillment. */
url?: ValueTypes['URL'] | null;
/** The name of the tracking company. */
company?: string | null;
};
/** The input fields used to create a fulfillment from fulfillment orders. */
['FulfillmentV2Input']: {
/** The fulfillment's tracking information, including a tracking URL, a tracking number,
and the company associated with the fulfillment. */
trackingInfo?: ValueTypes['FulfillmentTrackingInput'] | null;
/** Whether the customer is notified.
If `true`, then a notification is sent when the fulfillment is created. */
notifyCustomer?: boolean | null;
/** Pairs of `fulfillment_order_id` and `fulfillment_order_line_items` that represent the fulfillment
order line items that have to be fulfilled for each fulfillment order. For any given pair, if the
fulfillment order line items are left blank then all the fulfillment order line items of the
associated fulfillment order ID will be fulfilled. */
lineItemsByFulfillmentOrder: ValueTypes['FulfillmentOrderLineItemsInput'][];
/** Address information about the location from which the order was fulfilled. */
originAddress?: ValueTypes['FulfillmentOriginAddressInput'] | null;
};
/** A generic file. */
['GenericFile']: AliasType<{
/** A word or phrase to describe the contents or the function of a file. */
alt?: boolean;
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created. */
createdAt?: boolean;
/** Any errors that have occurred on the file. */
fileErrors?: ValueTypes['FileError'];
/** The status of the file. */
fileStatus?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The preview image for the media. */
preview?: ValueTypes['MediaPreviewImage'];
/** The URL of the file. */
url?: boolean;
__typename?: boolean;
}>;
/** Represents an issued gift card. */
['GiftCard']: AliasType<{
/** The gift card's remaining balance. */
balance?: ValueTypes['MoneyV2'];
/** The date and time at which the gift card was created. */
createdAt?: boolean;
/** The customer who will receive the gift card. */
customer?: ValueTypes['Customer'];
/** The date and time at which the gift card was disabled. */
disabledAt?: boolean;
/** Whether the gift card is enabled. */
enabled?: boolean;
/** The date at which the gift card will expire. */
expiresOn?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The initial value of the gift card. */
initialValue?: ValueTypes['MoneyV2'];
/** The final four characters of the gift card code. */
lastCharacters?: boolean;
/** The gift card code. Everything but the final four characters is masked. */
maskedCode?: boolean;
/** The note associated with the gift card, which is not visible to the customer. */
note?: boolean;
/** The order associated with the gift card. This value is `null` if the gift card was issued manually. */
order?: ValueTypes['Order'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple GiftCards. */
['GiftCardConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['GiftCardEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Specifies the input fields to issue a gift card. */
['GiftCardCreateInput']: {
/** The initial value of the gift card. */
initialValue: ValueTypes['Decimal'];
/** The gift card's code. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9).
It is not case sensitive. If not provided, then a random code will be generated. */
code?: string | null;
/** The ID of the customer who will receive the gift card. Requires `write_customers` access_scope. */
customerId?: string | null;
/** The date at which the gift card will expire. If not provided, then the gift card will never expire. */
expiresOn?: ValueTypes['Date'] | null;
/** The note associated with the gift card, which is not visible to the customer. */
note?: string | null;
/** The suffix of the Liquid template that is used to render the gift card online.
For example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`.
If not provided, then the default `gift_card.liquid` template is used. */
templateSuffix?: string | null;
};
/** Return type for `giftCardCreate` mutation. */
['GiftCardCreatePayload']: AliasType<{
/** The created gift card. */
giftCard?: ValueTypes['GiftCard'];
/** The created gift card's code. */
giftCardCode?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['GiftCardUserError'];
__typename?: boolean;
}>;
/** Return type for `giftCardDisable` mutation. */
['GiftCardDisablePayload']: AliasType<{
/** The disabled gift card. */
giftCard?: ValueTypes['GiftCard'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one GiftCard and a cursor during pagination. */
['GiftCardEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of GiftCardEdge. */
node?: ValueTypes['GiftCard'];
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `GiftCardUserError`. */
['GiftCardErrorCode']: GiftCardErrorCode;
/** A sale associated with a gift card. */
['GiftCardSale']: AliasType<{
/** The type of order action that the sale represents. */
actionType?: boolean;
/** The unique identifier for the sale. */
id?: boolean;
/** The line item for the associated sale. */
lineItem?: ValueTypes['LineItem'];
/** The line type assocated with the sale. */
lineType?: boolean;
/** The number of units either ordered or intended to be returned. */
quantity?: boolean;
/** All individual taxes associated with the sale. */
taxes?: ValueTypes['SaleTax'];
/** The total sale amount after taxes and discounts. */
totalAmount?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale after taxes. */
totalDiscountAmountAfterTaxes?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale before taxes. */
totalDiscountAmountBeforeTaxes?: ValueTypes['MoneyBag'];
/** The total amount of taxes for the sale. */
totalTaxAmount?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the GiftCard query. */
['GiftCardSortKeys']: GiftCardSortKeys;
/** Specifies the input fields to update a gift card. */
['GiftCardUpdateInput']: {
/** The note associated with the gift card, which is not visible to the customer. */
note?: string | null;
/** The date at which the gift card will expire. If set to `null`, then the gift card will never expire. */
expiresOn?: ValueTypes['Date'] | null;
/** The ID of the customer who will receive the gift card. The ID cannot be changed if the gift card already has an assigned customer ID. */
customerId?: string | null;
/** The suffix of the Liquid template that is used to render the gift card online.
For example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`. */
templateSuffix?: string | null;
};
/** Return type for `giftCardUpdate` mutation. */
['GiftCardUpdatePayload']: AliasType<{
/** The updated gift card. */
giftCard?: ValueTypes['GiftCard'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents an error that happens during the execution of a gift card mutation. */
['GiftCardUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** A string containing HTML code. Refer to the [HTML spec](https://html.spec.whatwg.org/#elements-3) for a
complete list of HTML elements.
Example value: `"<p>Grey cotton knit sweater.</p>"`. */
['HTML']: unknown;
/** Represents an object that has a list of events. */
['HasEvents']: AliasType<{
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
['...on Customer']?: Omit<ValueTypes['Customer'], keyof ValueTypes['HasEvents']>;
['...on DiscountAutomaticBxgy']?: Omit<ValueTypes['DiscountAutomaticBxgy'], keyof ValueTypes['HasEvents']>;
['...on DiscountAutomaticNode']?: Omit<ValueTypes['DiscountAutomaticNode'], keyof ValueTypes['HasEvents']>;
['...on DiscountCodeNode']?: Omit<ValueTypes['DiscountCodeNode'], keyof ValueTypes['HasEvents']>;
['...on DraftOrder']?: Omit<ValueTypes['DraftOrder'], keyof ValueTypes['HasEvents']>;
['...on Order']?: Omit<ValueTypes['Order'], keyof ValueTypes['HasEvents']>;
['...on PriceRule']?: Omit<ValueTypes['PriceRule'], keyof ValueTypes['HasEvents']>;
__typename?: boolean;
}>;
/** Localization extensions associated with the specified resource. For example, the tax id for government invoice. */
['HasLocalizationExtensions']: AliasType<{
localizationExtensions?: [
{
/** The country codes of the extensions. */
countryCodes?: ValueTypes['CountryCode'][] /** The purpose of the extensions. */;
purposes?: ValueTypes['LocalizationExtensionPurpose'][] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['LocalizationExtensionConnection']
];
['...on DraftOrder']?: Omit<ValueTypes['DraftOrder'], keyof ValueTypes['HasLocalizationExtensions']>;
['...on Order']?: Omit<ValueTypes['Order'], keyof ValueTypes['HasLocalizationExtensions']>;
__typename?: boolean;
}>;
/** Resources that metafield definitions can be applied to. */
['HasMetafieldDefinitions']: AliasType<{
metafieldDefinitions?: [
{
/** Filter metafield definitions by namespace. */
namespace?: string | null /** Filter by the definition's pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
['...on Collection']?: Omit<ValueTypes['Collection'], keyof ValueTypes['HasMetafieldDefinitions']>;
['...on Customer']?: Omit<ValueTypes['Customer'], keyof ValueTypes['HasMetafieldDefinitions']>;
['...on Location']?: Omit<ValueTypes['Location'], keyof ValueTypes['HasMetafieldDefinitions']>;
['...on Order']?: Omit<ValueTypes['Order'], keyof ValueTypes['HasMetafieldDefinitions']>;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['HasMetafieldDefinitions']>;
['...on ProductVariant']?: Omit<ValueTypes['ProductVariant'], keyof ValueTypes['HasMetafieldDefinitions']>;
__typename?: boolean;
}>;
/** Represents information about the metafields associated to the specified resource. */
['HasMetafields']: AliasType<{
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
['...on Collection']?: Omit<ValueTypes['Collection'], keyof ValueTypes['HasMetafields']>;
['...on Customer']?: Omit<ValueTypes['Customer'], keyof ValueTypes['HasMetafields']>;
['...on DraftOrder']?: Omit<ValueTypes['DraftOrder'], keyof ValueTypes['HasMetafields']>;
['...on Image']?: Omit<ValueTypes['Image'], keyof ValueTypes['HasMetafields']>;
['...on Order']?: Omit<ValueTypes['Order'], keyof ValueTypes['HasMetafields']>;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['HasMetafields']>;
['...on ProductVariant']?: Omit<ValueTypes['ProductVariant'], keyof ValueTypes['HasMetafields']>;
['...on Shop']?: Omit<ValueTypes['Shop'], keyof ValueTypes['HasMetafields']>;
__typename?: boolean;
}>;
/** Published translations associated with the resource. */
['HasPublishedTranslations']: AliasType<{
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
['...on Collection']?: Omit<ValueTypes['Collection'], keyof ValueTypes['HasPublishedTranslations']>;
['...on Link']?: Omit<ValueTypes['Link'], keyof ValueTypes['HasPublishedTranslations']>;
['...on OnlineStoreArticle']?: Omit<ValueTypes['OnlineStoreArticle'], keyof ValueTypes['HasPublishedTranslations']>;
['...on OnlineStoreBlog']?: Omit<ValueTypes['OnlineStoreBlog'], keyof ValueTypes['HasPublishedTranslations']>;
['...on OnlineStorePage']?: Omit<ValueTypes['OnlineStorePage'], keyof ValueTypes['HasPublishedTranslations']>;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['HasPublishedTranslations']>;
['...on ProductOption']?: Omit<ValueTypes['ProductOption'], keyof ValueTypes['HasPublishedTranslations']>;
['...on ProductVariant']?: Omit<ValueTypes['ProductVariant'], keyof ValueTypes['HasPublishedTranslations']>;
['...on Shop']?: Omit<ValueTypes['Shop'], keyof ValueTypes['HasPublishedTranslations']>;
['...on ShopPolicy']?: Omit<ValueTypes['ShopPolicy'], keyof ValueTypes['HasPublishedTranslations']>;
__typename?: boolean;
}>;
/** Represents an image resource. */
['Image']: AliasType<{
/** A word or phrase to share the nature or contents of an image. */
altText?: boolean;
/** The original height of the image in pixels. Returns `null` if the image is not hosted by Shopify. */
height?: boolean;
/** A unique identifier for the image. */
id?: boolean;
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
/** The location of the original image as a URL.
If there are any existing transformations in the original source URL, they will remain and not be stripped. */
originalSrc?: boolean;
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
/** The location of the image as a URL. */
src?: boolean;
transformedSrc?: [
{
/** Image width in pixels between 1 and 5760. */
maxWidth?: number | null /** Image height in pixels between 1 and 5760. */;
maxHeight?: number | null /** Crops the image according to the specified region. */;
crop?: ValueTypes['CropRegion'] | null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. */;
scale?: number | null /** Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported). */;
preferredContentType?: ValueTypes['ImageContentType'] | null;
},
boolean
];
url?: [
{
/** A set of options to transform the original image. */
transform?: ValueTypes['ImageTransformInput'] | null;
},
boolean
];
/** The original width of the image in pixels. Returns `null` if the image is not hosted by Shopify. */
width?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Images. */
['ImageConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ImageEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** List of supported image content types. */
['ImageContentType']: ImageContentType;
/** An auto-generated type which holds one Image and a cursor during pagination. */
['ImageEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ImageEdge. */
node?: ValueTypes['Image'];
__typename?: boolean;
}>;
/** Specifies the input fields for an image. */
['ImageInput']: {
/** A globally-unique identifier. */
id?: string | null;
/** A word or phrase to share the nature or contents of an image. */
altText?: string | null;
/** The URL of the image. May be a signed upload URL. */
src?: string | null;
};
/** 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. */
['ImageTransformInput']: {
/** Crop the image according to the specified region. */
crop?: ValueTypes['CropRegion'] | null;
/** Image width in pixels between 1 and 5760. */
maxWidth?: number | null;
/** Image height in pixels between 1 and 5760. */
maxHeight?: number | null;
/** Image size multiplier for high-resolution retina displays. Must be within 1..3. */
scale?: number | null;
/** 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?: ValueTypes['ImageContentType'] | null;
};
/** Upload parameter of an image. */
['ImageUploadParameter']: AliasType<{
/** Parameter name. */
name?: boolean;
/** Parameter value. */
value?: boolean;
__typename?: boolean;
}>;
/** Return type for `inventoryActivate` mutation. */
['InventoryActivatePayload']: AliasType<{
/** The inventory level that was activated. */
inventoryLevel?: ValueTypes['InventoryLevel'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the items and their adjustments. */
['InventoryAdjustItemInput']: {
/** ID of the inventory item to adjust. */
inventoryItemId: string;
/** The change applied to the `available` quantity of the item at the location. */
availableDelta: number;
};
/** Specifies the fields required to adjust the inventory quantity. */
['InventoryAdjustQuantityInput']: {
/** ID of the inventory level to adjust. */
inventoryLevelId: string;
/** The change applied to the `available` quantity of the item at the location. */
availableDelta: number;
};
/** Return type for `inventoryAdjustQuantity` mutation. */
['InventoryAdjustQuantityPayload']: AliasType<{
/** Represents the updated inventory quantity of an inventory item at a specific location. */
inventoryLevel?: ValueTypes['InventoryLevel'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `inventoryBulkAdjustQuantityAtLocation` mutation. */
['InventoryBulkAdjustQuantityAtLocationPayload']: AliasType<{
/** Represents the updated inventory quantities of an inventory item at the location. */
inventoryLevels?: ValueTypes['InventoryLevel'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `inventoryDeactivate` mutation. */
['InventoryDeactivatePayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents the goods available to be shipped to a customer.
It holds essential information about the goods, including SKU and whether it is tracked. */
['InventoryItem']: AliasType<{
/** The ISO 3166-1 alpha-2 country code of where the item originated from. */
countryCodeOfOrigin?: boolean;
countryHarmonizedSystemCodes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CountryHarmonizedSystemCodeConnection']
];
/** The date and time when the inventory item was created. */
createdAt?: boolean;
/** The number of inventory items that share the same SKU with this item. */
duplicateSkuCount?: boolean;
/** The harmonized system code of the item. */
harmonizedSystemCode?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The URL that points to the inventory history for the item. */
inventoryHistoryUrl?: boolean;
inventoryLevel?: [
{
/** ID of the location for which the inventory level is requested. */
locationId: string;
},
ValueTypes['InventoryLevel']
];
inventoryLevels?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `created_at`
- `inventory_group_id`
- `inventory_item_id`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['InventoryLevelConnection']
];
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The number of locations where this inventory item is stocked. */
locationsCount?: boolean;
/** The ISO 3166-2 alpha-2 province code of where the item originated from. */
provinceCodeOfOrigin?: boolean;
/** Whether the inventory item requires shipping. */
requiresShipping?: boolean;
/** Inventory item SKU. */
sku?: boolean;
/** Whether inventory levels are tracked for the item. */
tracked?: boolean;
/** Whether the value of the `tracked` field for the inventory item can be changed. */
trackedEditable?: ValueTypes['EditableProperty'];
/** Unit cost associated with the inventory item. */
unitCost?: ValueTypes['MoneyV2'];
/** The date and time when the inventory item was updated. */
updatedAt?: boolean;
/** The variant that owns this inventory item. */
variant?: ValueTypes['ProductVariant'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple InventoryItems. */
['InventoryItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['InventoryItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one InventoryItem and a cursor during pagination. */
['InventoryItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of InventoryItemEdge. */
node?: ValueTypes['InventoryItem'];
__typename?: boolean;
}>;
/** Specifies the input fields for an inventory item. */
['InventoryItemInput']: {
/** Unit cost associated with the inventory item, the currency is the shop's default currency. */
cost?: ValueTypes['Decimal'] | null;
/** Whether the inventory item is tracked. */
tracked?: boolean | null;
};
/** Inventory item. */
['InventoryItemUpdateInput']: {
/** Unit cost associated with the inventory item, the currency is the shop's default currency. */
cost?: ValueTypes['Decimal'] | null;
/** Whether the inventory item is tracked. The value must be true to adjust the item's inventory levels. */
tracked?: boolean | null;
/** The ISO 3166-1 alpha-2 country code of where the item originated from. */
countryCodeOfOrigin?: ValueTypes['CountryCode'] | null;
/** The ISO 3166-2 alpha-2 province/state code of where the item originated from. */
provinceCodeOfOrigin?: string | null;
/** The harmonized system code of the inventory item. This must be a number between 6 and 13 digits. */
harmonizedSystemCode?: string | null;
/** List of country-specific harmonized system codes. */
countryHarmonizedSystemCodes?: ValueTypes['CountryHarmonizedSystemCodeInput'][];
};
/** Return type for `inventoryItemUpdate` mutation. */
['InventoryItemUpdatePayload']: AliasType<{
/** The inventory item that was updated. */
inventoryItem?: ValueTypes['InventoryItem'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The quantities of an inventory item that are related to a specific location. */
['InventoryLevel']: AliasType<{
/** The quantity of inventory items that are available at the inventory level's associated location. */
available?: boolean;
/** Whether the inventory items associated with the inventory level can be deactivated. */
canDeactivate?: boolean;
/** The date and time when the inventory level was created. */
createdAt?: boolean;
/** Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated. */
deactivationAlert?: boolean;
/** Describes, in HTML with embedded URLs, either the impact of deactivating the inventory level or why the inventory level can't be deactivated. */
deactivationAlertHtml?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The quantity of inventory items that are going to the inventory level's associated location. */
incoming?: boolean;
/** Inventory item associated with the inventory level. */
item?: ValueTypes['InventoryItem'];
/** The location associated with the inventory level. */
location?: ValueTypes['Location'];
/** The date and time when the inventory level was updated. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple InventoryLevels. */
['InventoryLevelConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['InventoryLevelEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one InventoryLevel and a cursor during pagination. */
['InventoryLevelEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of InventoryLevelEdge. */
node?: ValueTypes['InventoryLevel'];
__typename?: boolean;
}>;
/** Specifies the input fields for an inventory level. */
['InventoryLevelInput']: {
/** The available quantity of an inventory item at a location. */
availableQuantity: number;
/** The ID of a location. */
locationId: string;
};
/** A [JSON](https://www.json.org/json-en.html) object.
Example value:
`{
"product": {
"id": "gid://shopify/Product/1346443542550",
"title": "White T-shirt",
"options": [{
"name": "Size",
"values": ["M", "L"]
}]
}
}` */
['JSON']: unknown;
/** A job corresponds to some long running task that the client should poll for status. */
['Job']: AliasType<{
/** This indicates if the job is still queued or has been run. */
done?: boolean;
/** A globally-unique identifier that's returned when running an asynchronous mutation. */
id?: boolean;
/** This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job. */
query?: ValueTypes['QueryRoot'];
__typename?: boolean;
}>;
/** Interoperability metadata for types that directly correspond to a REST Admin API resource.
For example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://shopify.dev/api/admin-graphql/latest/objects/product) in the REST Admin API. */
['LegacyInteroperability']: AliasType<{
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
['...on Customer']?: Omit<ValueTypes['Customer'], keyof ValueTypes['LegacyInteroperability']>;
['...on DraftOrder']?: Omit<ValueTypes['DraftOrder'], keyof ValueTypes['LegacyInteroperability']>;
['...on Fulfillment']?: Omit<ValueTypes['Fulfillment'], keyof ValueTypes['LegacyInteroperability']>;
['...on InventoryItem']?: Omit<ValueTypes['InventoryItem'], keyof ValueTypes['LegacyInteroperability']>;
['...on Location']?: Omit<ValueTypes['Location'], keyof ValueTypes['LegacyInteroperability']>;
['...on MarketingEvent']?: Omit<ValueTypes['MarketingEvent'], keyof ValueTypes['LegacyInteroperability']>;
['...on Metafield']?: Omit<ValueTypes['Metafield'], keyof ValueTypes['LegacyInteroperability']>;
['...on MetafieldStorefrontVisibility']?: Omit<ValueTypes['MetafieldStorefrontVisibility'], keyof ValueTypes['LegacyInteroperability']>;
['...on Order']?: Omit<ValueTypes['Order'], keyof ValueTypes['LegacyInteroperability']>;
['...on PriceRule']?: Omit<ValueTypes['PriceRule'], keyof ValueTypes['LegacyInteroperability']>;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['LegacyInteroperability']>;
['...on ProductVariant']?: Omit<ValueTypes['ProductVariant'], keyof ValueTypes['LegacyInteroperability']>;
['...on Refund']?: Omit<ValueTypes['Refund'], keyof ValueTypes['LegacyInteroperability']>;
['...on SavedSearch']?: Omit<ValueTypes['SavedSearch'], keyof ValueTypes['LegacyInteroperability']>;
['...on ScriptTag']?: Omit<ValueTypes['ScriptTag'], keyof ValueTypes['LegacyInteroperability']>;
['...on ShopifyPaymentsDispute']?: Omit<ValueTypes['ShopifyPaymentsDispute'], keyof ValueTypes['LegacyInteroperability']>;
['...on ShopifyPaymentsPayout']?: Omit<ValueTypes['ShopifyPaymentsPayout'], keyof ValueTypes['LegacyInteroperability']>;
['...on WebhookSubscription']?: Omit<ValueTypes['WebhookSubscription'], keyof ValueTypes['LegacyInteroperability']>;
__typename?: boolean;
}>;
/** The total number of pending orders on a shop if less then a maximum, or that maximum.
The atMax field indicates when this maximum has been reached. */
['LimitedPendingOrderCount']: AliasType<{
/** This is set when the number of pending orders has reached the maximum. */
atMax?: boolean;
/** The number of pendings orders on the shop.
Limited to a maximum of 10000. */
count?: boolean;
__typename?: boolean;
}>;
/** Represents a single line item on an order. */
['LineItem']: AliasType<{
/** Whether the line item can be restocked. */
canRestock?: boolean;
/** The subscription contract associated with this line item. */
contract?: ValueTypes['SubscriptionContract'];
/** The line item's quantity, minus the removed quantity. */
currentQuantity?: boolean;
/** A list of additional information about the line item. */
customAttributes?: ValueTypes['Attribute'];
/** The discounts that have been allocated onto the line item by discount applications. */
discountAllocations?: ValueTypes['DiscountAllocation'];
/** The total line price after discounts are applied, in shop currency. */
discountedTotal?: boolean;
/** The total line price after discounts are applied, in shop and presentment currencies. */
discountedTotalSet?: ValueTypes['MoneyBag'];
/** The approximate split price of a line item unit, in shop currency. This value doesn't include discounts applied to the entire order. */
discountedUnitPrice?: boolean;
/** The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order. */
discountedUnitPriceSet?: ValueTypes['MoneyBag'];
/** The duties associated with the line item. */
duties?: ValueTypes['Duty'];
/** The total number of units to fulfill. */
fulfillableQuantity?: boolean;
/** The service provider that fulfills the line item.
Deleted fulfillment services will return null. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,
'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. */
fulfillmentStatus?: boolean;
/** A globally-unique identifier. */
id?: boolean;
image?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** Whether the line item can be edited or not. */
merchantEditable?: boolean;
/** The name of the product. */
name?: boolean;
/** The total number of units that can't be fulfilled.
For example, if items have been refunded, or the item is not something that can be fulfilled,
like a tip.Please see the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object for more fulfillment details. */
nonFulfillableQuantity?: boolean;
/** The total price without discounts applied, in shop currency.
This value is based on the unit price of the variant x quantity. */
originalTotal?: boolean;
/** The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity. */
originalTotalSet?: ValueTypes['MoneyBag'];
/** The variant unit price without discounts applied, in shop currency. */
originalUnitPrice?: boolean;
/** The variant unit price without discounts applied, in shop and presentment currencies. */
originalUnitPriceSet?: ValueTypes['MoneyBag'];
/** The Product object associated with this line item's variant. */
product?: ValueTypes['Product'];
/** The number of variant units ordered. */
quantity?: boolean;
/** The line item's quantity, minus the removed quantity. */
refundableQuantity?: boolean;
/** Whether physical shipping is required for the variant. */
requiresShipping?: boolean;
/** Whether the line item can be restocked. */
restockable?: boolean;
/** The selling plan details associated with the line item. */
sellingPlan?: ValueTypes['LineItemSellingPlan'];
/** The variant SKU number. */
sku?: boolean;
taxLines?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['TaxLine']
];
/** Whether the variant is taxable. */
taxable?: boolean;
/** The title of the product. */
title?: boolean;
/** The sum of all AppliedDiscounts on this line item, in shop currency. */
totalDiscount?: boolean;
/** The sum of all AppliedDiscounts on this line item, in shop and presentment currencies. */
totalDiscountSet?: ValueTypes['MoneyBag'];
/** The total discounted value of unfulfilled units, in shop currency. */
unfulfilledDiscountedTotal?: boolean;
/** The total discounted value of unfulfilled units, in shop and presentment currencies. */
unfulfilledDiscountedTotalSet?: ValueTypes['MoneyBag'];
/** The total price, without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency. */
unfulfilledOriginalTotal?: boolean;
/** The total price, without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies. */
unfulfilledOriginalTotalSet?: ValueTypes['MoneyBag'];
/** The number of units not yet fulfilled. */
unfulfilledQuantity?: boolean;
/** The Variant object associated with this line item. */
variant?: ValueTypes['ProductVariant'];
/** The name of the variant. */
variantTitle?: boolean;
/** The name of the vendor who made the variant. */
vendor?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple LineItems. */
['LineItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['LineItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one LineItem and a cursor during pagination. */
['LineItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of LineItemEdge. */
node?: ValueTypes['LineItem'];
__typename?: boolean;
}>;
/** Represents a single line item on an order. */
['LineItemMutable']: AliasType<{
/** Whether the line item can be restocked. */
canRestock?: boolean;
/** A list of additional information about the line item. */
customAttributes?: ValueTypes['Attribute'];
/** The discounts that have been allocated onto the line item by discount applications. */
discountAllocations?: ValueTypes['DiscountAllocation'];
/** The total line price after discounts are applied, in shop currency. */
discountedTotal?: boolean;
/** The total line price after discounts are applied, in shop and presentment currencies. */
discountedTotalSet?: ValueTypes['MoneyBag'];
/** The approximate split price of a line item unit, in shop currency. This value doesn't include discounts applied to the entire order. */
discountedUnitPrice?: boolean;
/** The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order. */
discountedUnitPriceSet?: ValueTypes['MoneyBag'];
/** The total number of units to fulfill. */
fulfillableQuantity?: boolean;
/** The service provider that fulfills the line item.
Deleted fulfillment services will return null. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,
'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. */
fulfillmentStatus?: boolean;
/** A globally-unique identifier. */
id?: boolean;
image?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** Whether the line item can be edited or not. */
merchantEditable?: boolean;
/** The name of the product. */
name?: boolean;
/** The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. */
nonFulfillableQuantity?: boolean;
/** The total price without any discounts applied, in shop currency. ""This value is based on the unit price of the variant x quantity. */
originalTotal?: boolean;
/** The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity. */
originalTotalSet?: ValueTypes['MoneyBag'];
/** The variant unit price without discounts applied, in shop currency. */
originalUnitPrice?: boolean;
/** The variant unit price without discounts applied, in shop and presentment currencies. */
originalUnitPriceSet?: ValueTypes['MoneyBag'];
/** The Product object associated with this line item's variant. */
product?: ValueTypes['Product'];
/** The number of variant units ordered. */
quantity?: boolean;
/** The line item's quantity, minus the removed quantity. */
refundableQuantity?: boolean;
/** Whether physical shipping is required for the variant. */
requiresShipping?: boolean;
/** Whether the line item can be restocked. */
restockable?: boolean;
/** The variant SKU number. */
sku?: boolean;
taxLines?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['TaxLine']
];
/** Whether the variant is taxable. */
taxable?: boolean;
/** The title of the product. */
title?: boolean;
/** The sum of all AppliedDiscounts on this line item, in shop currency. */
totalDiscount?: boolean;
/** The sum of all AppliedDiscounts on this line item in shop and presentment currencies. */
totalDiscountSet?: ValueTypes['MoneyBag'];
/** The total discounted value of unfulfilled units, in shop currency. */
unfulfilledDiscountedTotal?: boolean;
/** The total discounted value of unfulfilled units, in shop and presentment currencies. */
unfulfilledDiscountedTotalSet?: ValueTypes['MoneyBag'];
/** The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency. */
unfulfilledOriginalTotal?: boolean;
/** The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies. */
unfulfilledOriginalTotalSet?: ValueTypes['MoneyBag'];
/** The number of units not yet fulfilled. */
unfulfilledQuantity?: boolean;
/** The Variant object associated with this line item. */
variant?: ValueTypes['ProductVariant'];
/** The name of the variant. */
variantTitle?: boolean;
/** The name of the vendor who made the variant. */
vendor?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple LineItemMutables. */
['LineItemMutableConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['LineItemMutableEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one LineItemMutable and a cursor during pagination. */
['LineItemMutableEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of LineItemMutableEdge. */
node?: ValueTypes['LineItemMutable'];
__typename?: boolean;
}>;
/** Represents the selling plan for a line item. */
['LineItemSellingPlan']: AliasType<{
/** The name of the selling plan for display purposes. */
name?: boolean;
__typename?: boolean;
}>;
/** A link to direct users to. */
['Link']: AliasType<{
/** A context-sensitive label for the link. */
label?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
/** The URL that the link visits. */
url?: boolean;
__typename?: boolean;
}>;
/** A locale. */
['Locale']: AliasType<{
/** Locale ISO code. */
isoCode?: boolean;
/** Human-readable locale name. */
name?: boolean;
__typename?: boolean;
}>;
/** Represents the value captured by a localization extension. Localization extensions are additional fields required by certain countries on international orders. For example, some countries require additional fields for customs information or tax identification numbers. */
['LocalizationExtension']: AliasType<{
/** Country ISO 3166-1 alpha-2 code. */
countryCode?: boolean;
/** The localized extension keys that are allowed. */
key?: boolean;
/** The purpose of this localization extension. */
purpose?: boolean;
/** The localized extension title. */
title?: boolean;
/** The value of the field. */
value?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple LocalizationExtensions. */
['LocalizationExtensionConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['LocalizationExtensionEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one LocalizationExtension and a cursor during pagination. */
['LocalizationExtensionEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of LocalizationExtensionEdge. */
node?: ValueTypes['LocalizationExtension'];
__typename?: boolean;
}>;
/** Specifies the input fields for a LocalizationExtensionInput. */
['LocalizationExtensionInput']: {
/** The key for the localization extension. */
key: ValueTypes['LocalizationExtensionKey'];
/** The localization extension value. */
value: string;
};
/** The key of a localization extension. */
['LocalizationExtensionKey']: LocalizationExtensionKey;
/** The purpose of a localization extension. */
['LocalizationExtensionPurpose']: LocalizationExtensionPurpose;
/** Represents the location where the physical good resides. */
['Location']: AliasType<{
/** Whether this location can be reactivated. */
activatable?: boolean;
/** The address of this location. */
address?: ValueTypes['LocationAddress'];
/** Whether the location address has been verified. */
addressVerified?: boolean;
/** Whether this location can be deactivated. */
deactivatable?: boolean;
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as `"2019-09-07T15:50:00Z`". */
deactivatedAt?: boolean;
/** Whether this location can be deleted. */
deletable?: boolean;
/** Name of the service provider that fulfills from this location. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** Whether this location can fulfill online orders. */
fulfillsOnlineOrders?: boolean;
/** Whether this location has active inventory. */
hasActiveInventory?: boolean;
/** Whether this location has orders that need to be fulfilled. */
hasUnfulfilledOrders?: boolean;
/** A globally-unique identifier. */
id?: boolean;
inventoryLevel?: [
{
/** The ID of the inventory item to obtain the inventory level for. */
inventoryItemId: string;
},
ValueTypes['InventoryLevel']
];
inventoryLevels?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `created_at`
- `inventory_group_id`
- `inventory_item_id`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['InventoryLevelConnection']
];
/** Whether the location is active. */
isActive?: boolean;
/** Whether the location is your primary location for shipping inventory. */
isPrimary?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
metafieldDefinitions?: [
{
/** Filter metafield definitions by namespace. */
namespace?: string | null /** Filter by the definition's pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
/** The name of the location. */
name?: boolean;
/** Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. */
shipsInventory?: boolean;
/** List of suggested addresses for this location (empty if none). */
suggestedAddresses?: ValueTypes['LocationSuggestedAddress'];
__typename?: boolean;
}>;
/** Represents the address of a location. */
['LocationAddress']: AliasType<{
/** The first line of the address for the location. */
address1?: boolean;
/** The second line of the address for the location. */
address2?: boolean;
/** The city of the location. */
city?: boolean;
/** The country of the location. */
country?: boolean;
/** The country code of the location. */
countryCode?: boolean;
/** A formatted version of the address for the location. */
formatted?: boolean;
/** The latitude coordinates of the location. */
latitude?: boolean;
/** The longitude coordinates of the location. */
longitude?: boolean;
/** The phone number of the location. */
phone?: boolean;
/** The province of the location. */
province?: boolean;
/** The code for the province, state, or district of the address of the location. */
provinceCode?: boolean;
/** The ZIP code of the location. */
zip?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Locations. */
['LocationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['LocationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Location and a cursor during pagination. */
['LocationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of LocationEdge. */
node?: ValueTypes['Location'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the Location query. */
['LocationSortKeys']: LocationSortKeys;
/** Represents a suggested address for a location. */
['LocationSuggestedAddress']: AliasType<{
/** The first line of the suggested address. */
address1?: boolean;
/** The second line of the suggested address. */
address2?: boolean;
/** The city of the suggested address. */
city?: boolean;
/** The country of the suggested address. */
country?: boolean;
/** The country code of the suggested address. */
countryCode?: boolean;
/** A formatted version of the suggested address. */
formatted?: boolean;
/** The province of the suggested address. */
province?: boolean;
/** The code for the province, state, or district of the suggested address. */
provinceCode?: boolean;
/** The ZIP code of the suggested address. */
zip?: boolean;
__typename?: boolean;
}>;
/** Represents a customer mailing address.
For example, a customer's default address and an order's billing address are both mailling addresses. */
['MailingAddress']: AliasType<{
/** The first line of the address. Typically the street address or PO Box number. */
address1?: boolean;
/** The second line of the address. Typically the number of the apartment, suite, or unit. */
address2?: boolean;
/** The name of the city, district, village, or town. */
city?: boolean;
/** The name of the customer's company or organization. */
company?: boolean;
/** The name of the country. */
country?: boolean;
/** The two-letter code for the country of the address.
For example, US. */
countryCode?: boolean;
/** The two-letter code for the country of the address.
For example, US. */
countryCodeV2?: boolean;
/** The first name of the customer. */
firstName?: boolean;
formatted?: [
{
/** Whether to include the customer's name in the formatted address. */
withName?: boolean | null /** Whether to include the customer's company in the formatted address. */;
withCompany?: boolean | null;
},
boolean
];
/** A comma-separated list of the values for city, province, and country. */
formattedArea?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The last name of the customer. */
lastName?: boolean;
/** The latitude coordinate of the customer address. */
latitude?: boolean;
/** The longitude coordinate of the customer address. */
longitude?: boolean;
/** The full name of the customer, based on firstName and lastName. */
name?: boolean;
/** A unique phone number for the customer.
Formatted using E.164 standard. For example, _+16135551111_. */
phone?: boolean;
/** The region of the address, such as the province, state, or district. */
province?: boolean;
/** The two-letter code for the region.
For example, ON. */
provinceCode?: boolean;
/** The zip or postal code of the address. */
zip?: boolean;
__typename?: boolean;
}>;
/** The fields used to create or update a mailing address. */
['MailingAddressInput']: {
/** The first line of the address. Typically the street address or PO Box number. */
address1?: string | null;
/** The second line of the address. Typically the number of the apartment, suite, or unit. */
address2?: string | null;
/** The name of the city, district, village, or town. */
city?: string | null;
/** The name of the customer's company or organization. */
company?: string | null;
/** The name of the country. This argument is deprecated: Use `countryCode` instead. */
country?: string | null;
/** The two-letter code for the country of the address. */
countryCode?: ValueTypes['CountryCode'] | null;
/** The first name of the customer. */
firstName?: string | null;
/** This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed. */
id?: string | null;
/** The last name of the customer. */
lastName?: string | null;
/** A unique phone number for the customer.
Formatted using E.164 standard. For example, _+16135551111_. */
phone?: string | null;
/** The region of the address, such as the province, state, or district. This argument is deprecated: Use `provinceCode` instead. */
province?: string | null;
/** The code for the region of the address, such as the province, state, or district.
For example QC for Quebec, Canada. */
provinceCode?: string | null;
/** The zip or postal code of the address. */
zip?: string | null;
};
/** Manual discount applications capture the intentions of a discount that was manually created for an order. */
['ManualDiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The description of the discount application. */
description?: boolean;
/** An ordered index that can be used to identify the discount application and indicate the precedence
of the discount application for calculations. */
index?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The title of the discount application. */
title?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** The marketing activity resource represents marketing that a
merchant created through an app. */
['MarketingActivity']: AliasType<{
/** The URL of the marketing activity listing page in the marketing section. */
activityListUrl?: boolean;
/** The amount spent on the marketing activity. */
adSpend?: ValueTypes['MoneyV2'];
/** The app which created this marketing activity. */
app?: ValueTypes['App'];
/** The errors generated when an app publishes the marketing activity. */
appErrors?: ValueTypes['MarketingActivityExtensionAppErrors'];
/** The allocated budget for the marketing activity. */
budget?: ValueTypes['MarketingBudget'];
/** The date and time when the marketing activity was created. */
createdAt?: boolean;
/** The completed content in the marketing activity creation form. */
formData?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Whether the marketing activity is in the main workflow version of
the marketing automation. */
inMainWorkflowVersion?: boolean;
/** The available marketing channels for a marketing activity. */
marketingChannel?: boolean;
/** Associated marketing event of this marketing activity. */
marketingEvent?: ValueTypes['MarketingEvent'];
/** A contextual description of the marketing activity based on the platform and tactic used. */
sourceAndMedium?: boolean;
/** The current state of the marketing activity. */
status?: boolean;
/** The severity of the marketing activity's status. */
statusBadgeType?: boolean;
/** The rendered status of the marketing activity. */
statusLabel?: boolean;
/** The [date and time](
https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601
) when the activity's status last changed. */
statusTransitionedAt?: boolean;
/** The method of marketing used for this marketing activity. */
tactic?: boolean;
/** The status to which the marketing activity is currently transitioning. */
targetStatus?: boolean;
/** The marketing activity's title, which is rendered on the marketing listing page. */
title?: boolean;
/** The date and time when the marketing activity was updated. */
updatedAt?: boolean;
/** The set of [Urchin Tracking Module](
https://help.shopify.com/https://en.wikipedia.org/wiki/UTM_parameters
) used in the URL for tracking this marketing activity. */
utmParameters?: ValueTypes['UTMParameters'];
__typename?: boolean;
}>;
/** This type combines budget amount and its marketing budget type. */
['MarketingActivityBudgetInput']: {
/** Budget type for marketing activity. */
budgetType?: ValueTypes['MarketingBudgetBudgetType'] | null;
/** Amount of budget for the marketing activity. */
total?: ValueTypes['MoneyInput'] | null;
};
/** An auto-generated type for paginating through multiple MarketingActivities. */
['MarketingActivityConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['MarketingActivityEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Specifies the input fields required to create a marketing activity. */
['MarketingActivityCreateInput']: {
/** The title of the marketing activity. */
marketingActivityTitle?: string | null;
/** The form data in JSON serialized as a string. */
formData?: string | null;
/** The ID of the marketing activity extension. */
marketingActivityExtensionId: string;
/** Encoded context containing marketing campaign id. */
context?: string | null;
/** Specifies the
[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)
that are associated with a related marketing campaign. UTMInput is required for all Marketing
tactics except Storefront App. */
utm?: ValueTypes['UTMInput'] | null;
/** The current state of the marketing activity. */
status: ValueTypes['MarketingActivityStatus'];
/** The budget for this marketing activity. */
budget?: ValueTypes['MarketingActivityBudgetInput'] | null;
};
/** Return type for `marketingActivityCreate` mutation. */
['MarketingActivityCreatePayload']: AliasType<{
/** The created marketing activity. */
marketingActivity?: ValueTypes['MarketingActivity'];
/** The path to return back to shopify admin from embedded editor. */
redirectPath?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one MarketingActivity and a cursor during pagination. */
['MarketingActivityEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of MarketingActivityEdge. */
node?: ValueTypes['MarketingActivity'];
__typename?: boolean;
}>;
/** The error code resulted from the marketing activity extension integration. */
['MarketingActivityExtensionAppErrorCode']: MarketingActivityExtensionAppErrorCode;
/** Represents errors returned from apps when using the marketing activity extension. */
['MarketingActivityExtensionAppErrors']: AliasType<{
/** The app error type. */
code?: boolean;
/** The list of errors returned by the app. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the MarketingActivity query. */
['MarketingActivitySortKeys']: MarketingActivitySortKeys;
/** Status helps to identify if this marketing activity has been completed, queued, failed etc. */
['MarketingActivityStatus']: MarketingActivityStatus;
/** StatusBadgeType helps to identify the color of the status badge. */
['MarketingActivityStatusBadgeType']: MarketingActivityStatusBadgeType;
/** Specifies the input fields required to update a marketing activity. */
['MarketingActivityUpdateInput']: {
/** The ID of the marketing activity. */
id: string;
/** The ID of the recommendation that the marketing activity was created from, if one exists. */
marketingRecommendationId?: string | null;
/** The title of the marketing activity. */
title?: string | null;
/** The budget for the marketing activity. */
budget?: ValueTypes['MarketingActivityBudgetInput'] | null;
/** The cumulative amount spent on the marketing activity. This argument is deprecated: Use `MarketingEngagementCreate.MarketingEngagementInput.adSpend` GraphQL to send the ad spend. */
adSpend?: ValueTypes['MoneyInput'] | null;
/** The current state of the marketing activity. Learn more about
[marketing activity status](/apps/app-extensions/marketing-activities/reference/status). */
status?: ValueTypes['MarketingActivityStatus'] | null;
/** The target state that the marketing activity is transitioning to. Learn more about [marketing activity status](/apps/app-extensions/marketing-activities/reference/status). */
targetStatus?: ValueTypes['MarketingActivityStatus'] | null;
/** The form data of the marketing activity. This is only used if the marketing activity is
integrated with the external editor. */
formData?: string | null;
/** Specifies the
[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)
that are associated with a related marketing campaign. UTMInput is required for all Marketing
tactics except Storefront App. The utm field can only be set once and never modified. */
utm?: ValueTypes['UTMInput'] | null;
/** A list of the item IDs that were marketed in this marketing activity. Valid types for these items are:
* `Product`
* `Shop` */
marketedResources?: string[];
/** Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback. */
context?: string | null;
/** Error messages generated when the app was trying to complete this activity.
Learn more about the
JSON[format expected for the error messages](/apps/app-extensions/marketing-activities/reference
/status#failed-status). */
errors?: ValueTypes['JSON'] | null;
};
/** Return type for `marketingActivityUpdate` mutation. */
['MarketingActivityUpdatePayload']: AliasType<{
/** The updated marketing activity. */
marketingActivity?: ValueTypes['MarketingActivity'];
/** The redirect path from the embedded editor to the Shopify admin. */
redirectPath?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** This type combines budget amount and its marketing budget type. */
['MarketingBudget']: AliasType<{
/** The budget type for a marketing activity. */
budgetType?: boolean;
/** The amount of budget for marketing activity. */
total?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** The budget type for a marketing activity. */
['MarketingBudgetBudgetType']: MarketingBudgetBudgetType;
/** The available marketing channels for a marketing activity or event. A marketing channel is broad category of marketing, used for reporting aggregation. */
['MarketingChannel']: MarketingChannel;
/** Marketing engagement represents customer activity taken on a marketing event. */
['MarketingEngagement']: AliasType<{
/** The total ad spend for the day, if the marketing event is a paid ad with a daily spend. */
adSpend?: ValueTypes['MoneyV2'];
/** The total number of clicks on the marketing event for the day. */
clicksCount?: boolean;
/** The total number of comments for the day. */
commentsCount?: boolean;
/** The total number of complaints for the day. */
complaintsCount?: boolean;
/** The total number of fails for the day. */
failsCount?: boolean;
/** The total number of favorites for the day. */
favoritesCount?: boolean;
/** The date time at which the data was fetched. */
fetchedAt?: boolean;
/** The total number of impressions for the day. */
impressionsCount?: boolean;
/** Whether the engagements are reported as lifetime values rather than daily totals. */
isCumulative?: boolean;
/** The marketing activity related to this engagement. */
marketingActivity?: ValueTypes['MarketingActivity'];
/** The date that these engagements occurred on. */
occurredOn?: boolean;
/** The total number of sends for the day. */
sendsCount?: boolean;
/** The total number of shares for the day. */
sharesCount?: boolean;
/** The total number of unique clicks for the day. */
uniqueClicksCount?: boolean;
/** The total number of unique views for the day. */
uniqueViewsCount?: boolean;
/** The total number of unsubscribes for the day. */
unsubscribesCount?: boolean;
/** The UTC Offset that the app is using to determine which date to allocate spend to. */
utcOffset?: boolean;
/** The total number of views for the day. */
viewsCount?: boolean;
__typename?: boolean;
}>;
/** Return type for `marketingEngagementCreate` mutation. */
['MarketingEngagementCreatePayload']: AliasType<{
/** The marketing engagement that was created. */
marketingEngagement?: ValueTypes['MarketingEngagement'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** This object represents marketing engagement input fields for a marketing engagement. */
['MarketingEngagementInput']: {
/** The date that these engagements occurred on. */
occurredOn: ValueTypes['Date'];
/** The total number of impressions for the day. */
impressionsCount?: number | null;
/** The total number of views for the day. */
viewsCount?: number | null;
/** The total number of clicks on the marketing event for the day. */
clicksCount?: number | null;
/** The total number of shares for the day. */
sharesCount?: number | null;
/** The total number of favorites for the day. */
favoritesCount?: number | null;
/** The total number of comments for the day. */
commentsCount?: number | null;
/** The total number of unsubscribes for the day. */
unsubscribesCount?: number | null;
/** The total number of complaints for the day. */
complaintsCount?: number | null;
/** The total number of fails for the day. */
failsCount?: number | null;
/** The total number of sends for the day. */
sendsCount?: number | null;
/** The total number of unique views for the day. */
uniqueViewsCount?: number | null;
/** The total number of unique clicks for the day. */
uniqueClicksCount?: number | null;
/** The total ad spend for the day, if the marketing event is a paid ad with a daily spend. */
adSpend?: ValueTypes['MoneyInput'] | null;
/** Whether the engagements are reported as lifetime values rather than daily totals. */
isCumulative?: boolean | null;
/** The UTC Offset that the app is using to determine which date to allocate spend to. */
utcOffset?: ValueTypes['UtcOffset'] | null;
/** The date time at which the data was fetched. */
fetchedAt?: ValueTypes['DateTime'] | null;
};
/** Represents actions that market a merchant's store or products. */
['MarketingEvent']: AliasType<{
/** The app that the marketing event is attributed to. */
app?: ValueTypes['App'];
/** The marketing channel used by the marketing event. */
channel?: boolean;
/** A human-readable description of the marketing event. */
description?: boolean;
/** The date and time when the marketing event ended. */
endedAt?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The URL where the marketing event can be managed. */
manageUrl?: boolean;
/** The URL where the marketing event can be previewed. */
previewUrl?: boolean;
/** An optional ID that helps Shopify validate engagement data. */
remoteId?: boolean;
/** The date and time when the marketing event is scheduled to end. */
scheduledToEndAt?: boolean;
/** Where the `MarketingEvent` occurred and what kind of content was used.
Because `utmSource` and `utmMedium` are often used interchangeably, this is
based on a combination of `marketingChannel`, `referringDomain`, and `type` to
provide a consistent representation for any given piece of marketing
regardless of the app that created it. */
sourceAndMedium?: boolean;
/** The date and time when the marketing event started. */
startedAt?: boolean;
/** The display text for the marketing event type. */
targetTypeDisplayText?: boolean;
/** The marketing event type. */
type?: boolean;
/** The name of the marketing campaign. */
utmCampaign?: boolean;
/** The medium that the marketing campaign is using. Example values: `cpc`, `banner`. */
utmMedium?: boolean;
/** The referrer of the marketing event. Example values: `google`, `newsletter`. */
utmSource?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple MarketingEvents. */
['MarketingEventConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['MarketingEventEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one MarketingEvent and a cursor during pagination. */
['MarketingEventEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of MarketingEventEdge. */
node?: ValueTypes['MarketingEvent'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the MarketingEvent query. */
['MarketingEventSortKeys']: MarketingEventSortKeys;
/** The available types of marketing event. */
['MarketingTactic']: MarketingTactic;
/** Represents a media interface. */
['Media']: AliasType<{
/** A word or phrase to share the nature or contents of a media. */
alt?: boolean;
/** The media content type. */
mediaContentType?: boolean;
/** Any errors which have occurred on the media. */
mediaErrors?: ValueTypes['MediaError'];
/** The warnings attached to the media. */
mediaWarnings?: ValueTypes['MediaWarning'];
/** The preview image for the media. */
preview?: ValueTypes['MediaPreviewImage'];
/** Current status of the media. */
status?: boolean;
['...on ExternalVideo']?: Omit<ValueTypes['ExternalVideo'], keyof ValueTypes['Media']>;
['...on MediaImage']?: Omit<ValueTypes['MediaImage'], keyof ValueTypes['Media']>;
['...on Model3d']?: Omit<ValueTypes['Model3d'], keyof ValueTypes['Media']>;
['...on Video']?: Omit<ValueTypes['Video'], keyof ValueTypes['Media']>;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Media. */
['MediaConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['MediaEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** The possible content types for a media object. */
['MediaContentType']: MediaContentType;
/** An auto-generated type which holds one Media and a cursor during pagination. */
['MediaEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of MediaEdge. */
node?: ValueTypes['Media'];
__typename?: boolean;
}>;
/** Represents a media error. */
['MediaError']: AliasType<{
/** Code representing the type of error. */
code?: boolean;
/** Additional details regarding the error. */
details?: boolean;
/** Translated error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Error types for media. */
['MediaErrorCode']: MediaErrorCode;
/** Host for a Media Resource. */
['MediaHost']: MediaHost;
/** An image hosted on Shopify. */
['MediaImage']: AliasType<{
/** A word or phrase to share the nature or contents of a media. */
alt?: boolean;
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created. */
createdAt?: boolean;
/** Any errors that have occurred on the file. */
fileErrors?: ValueTypes['FileError'];
/** The status of the file. */
fileStatus?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The image for the media. Returns `null` until `status` is `READY`. */
image?: ValueTypes['Image'];
/** The media content type. */
mediaContentType?: boolean;
/** Any errors which have occurred on the media. */
mediaErrors?: ValueTypes['MediaError'];
/** The warnings attached to the media. */
mediaWarnings?: ValueTypes['MediaWarning'];
/** The MIME type of the image. */
mimeType?: boolean;
/** The preview image for the media. */
preview?: ValueTypes['MediaPreviewImage'];
/** Current status of the media. */
status?: boolean;
__typename?: boolean;
}>;
/** Represents the preview image for a media. */
['MediaPreviewImage']: AliasType<{
/** The preview image for the media. Returns `null` until `status` is `READY`. */
image?: ValueTypes['Image'];
/** Current status of the preview image. */
status?: boolean;
__typename?: boolean;
}>;
/** The possible statuses for a media preview image. */
['MediaPreviewImageStatus']: MediaPreviewImageStatus;
/** The possible statuses for a media object. */
['MediaStatus']: MediaStatus;
/** Represents an error that happens during execution of a Media query or mutation. */
['MediaUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `MediaUserError`. */
['MediaUserErrorCode']: MediaUserErrorCode;
/** Represents a media warning. */
['MediaWarning']: AliasType<{
/** The code representing the type of warning. */
code?: boolean;
/** Translated warning message. */
message?: boolean;
__typename?: boolean;
}>;
/** Warning types for media. */
['MediaWarningCode']: MediaWarningCode;
/** Merchant approval for accelerated onboarding to channel integration apps. */
['MerchantApprovalSignals']: AliasType<{
/** Whether the shop's Shopify Payments account identity is verified. Returns `false` if the identity is unverified or if the shop doesn't have a Shopify Payments account. */
identityVerified?: boolean;
/** Whether Shopify has pre-verified the merchant's business for onboarding to channel integration apps. Returns `false` if the shop is not marked for verification. */
verifiedByShopify?: boolean;
__typename?: boolean;
}>;
/** Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection).
For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields).
Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers.
Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value. */
['Metafield']: AliasType<{
/** The date and time when the metafield was created. */
createdAt?: boolean;
/** The optional, associated metafield definition that maps to this metafield's namespace and key pair. */
definition?: ValueTypes['MetafieldDefinition'];
/** The description of the metafield. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The unique identifier for the metafield in its namespace. */
key?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** A container for a group of metafields.
Grouping metafields within a namespace prevents your metafields from conflicting with other metafields that have the same key name. */
namespace?: boolean;
/** The resource that the metafield is attached to. */
owner?: ValueTypes['HasMetafields'];
/** The resource that the metafield is attached to. */
ownerType?: boolean;
/** Returns a reference object if the metafield definition's type is a resource reference. */
reference?: ValueTypes['MetafieldReference'];
/** The type of data that the metafield stores in the `value` field.
See the list of [supported types](https://shopify.dev/apps/metafields/types). */
type?: boolean;
/** The date and time when the metafield was updated. */
updatedAt?: boolean;
/** The data to store in the metafield. The data is always stored as a string, regardless of the metafield's type. */
value?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Metafields. */
['MetafieldConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['MetafieldEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Metafield definitions enable you to define additional validation constraints for metafields, and enable the
merchant to edit metafield values in context. */
['MetafieldDefinition']: AliasType<{
/** The description of a metafield definition. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The key name used to identify a metafield definition within a namespace. */
key?: boolean;
metafields?: [
{
/** Returns the metafields filtered by the validation status. */
validationStatus?: ValueTypes['MetafieldValidationStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
metafieldsCount?: [
{
/** The current validation status. */
validationStatus?: ValueTypes['MetafieldValidationStatus'] | null;
},
boolean
];
/** The human-readable name for the metafield definition. */
name?: boolean;
/** The namespace of the metafield definition. You can use a namespace to group related metafields. */
namespace?: boolean;
/** The resource type that the metafield definition is attached to. For example, `Product` or `Collection`. */
ownerType?: boolean;
/** The position of the metafield definition in the pinned list. */
pinnedPosition?: boolean;
/** The standard metafield definition template associated with a metafield definition. */
standardTemplate?: ValueTypes['StandardMetafieldDefinitionTemplate'];
/** The type of data that the metafield will store. */
type?: ValueTypes['MetafieldDefinitionType'];
/** The validation status for the existing metafields within a metafield definition. */
validationStatus?: boolean;
/** A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for
the metafield. For example, for a metafield with the type `date`, you can set a minimum date validation, so
that the metafield will only store dates after the specific minimum date. */
validations?: ValueTypes['MetafieldDefinitionValidation'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple MetafieldDefinitions. */
['MetafieldDefinitionConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['MetafieldDefinitionEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `metafieldDefinitionCreate` mutation. */
['MetafieldDefinitionCreatePayload']: AliasType<{
/** The metafield definition that was created. */
createdDefinition?: ValueTypes['MetafieldDefinition'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MetafieldDefinitionCreateUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `MetafieldDefinitionCreate`. */
['MetafieldDefinitionCreateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `MetafieldDefinitionCreateUserError`. */
['MetafieldDefinitionCreateUserErrorCode']: MetafieldDefinitionCreateUserErrorCode;
/** Return type for `metafieldDefinitionDelete` mutation. */
['MetafieldDefinitionDeletePayload']: AliasType<{
/** The id of the deleted metafield definition. */
deletedDefinitionId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MetafieldDefinitionDeleteUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `MetafieldDefinitionDelete`. */
['MetafieldDefinitionDeleteUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `MetafieldDefinitionDeleteUserError`. */
['MetafieldDefinitionDeleteUserErrorCode']: MetafieldDefinitionDeleteUserErrorCode;
/** An auto-generated type which holds one MetafieldDefinition and a cursor during pagination. */
['MetafieldDefinitionEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of MetafieldDefinitionEdge. */
node?: ValueTypes['MetafieldDefinition'];
__typename?: boolean;
}>;
/** Specifies the input fields that are required to create a metafield definition. */
['MetafieldDefinitionInput']: {
/** The namespace to group a metafield definition. */
namespace: string;
/** The key name used to identify a metafield definition within a namespace. */
key: string;
/** The human-readable name for the metafield definition. */
name: string;
/** The description for the metafield definition. */
description?: string | null;
/** The resource type that the metafield definition is attached to. */
ownerType: ValueTypes['MetafieldOwnerType'];
/** The type of data that the metafield will store. */
type: string;
/** A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for
the metafield. For example, for a metafield with the type `date`, you can set a minimum date validation, so
that the metafield will only store dates after the specific minimum date. */
validations?: ValueTypes['MetafieldDefinitionValidationInput'][];
/** Whether to pin the metafield definition. */
pin?: boolean | null;
};
/** Return type for `metafieldDefinitionPin` mutation. */
['MetafieldDefinitionPinPayload']: AliasType<{
/** The metafield definition that was pinned. */
pinnedDefinition?: ValueTypes['MetafieldDefinition'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MetafieldDefinitionPinUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `MetafieldDefinitionPin`. */
['MetafieldDefinitionPinUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `MetafieldDefinitionPinUserError`. */
['MetafieldDefinitionPinUserErrorCode']: MetafieldDefinitionPinUserErrorCode;
/** Possible metafield definition pinned statuses. */
['MetafieldDefinitionPinnedStatus']: MetafieldDefinitionPinnedStatus;
/** The set of valid sort keys for the MetafieldDefinition query. */
['MetafieldDefinitionSortKeys']: MetafieldDefinitionSortKeys;
/** The type and name for the optional validation configuration of a metafield.
For example, a supported validation might consist of a `max` name and a `number_integer` type.
This validation can then be used to enforce a maximum character length for a `single_line_text_field` metafield. */
['MetafieldDefinitionSupportedValidation']: AliasType<{
/** The name of the metafield definition validation. */
name?: boolean;
/** The type of input for the validation. */
type?: boolean;
__typename?: boolean;
}>;
/** A metafield definition type provides basic foundation and validation for a metafield. */
['MetafieldDefinitionType']: AliasType<{
/** The category associated with the metafield definition type. */
category?: boolean;
/** The name of the type for the metafield definition.
See the list of [supported types](https://shopify.dev/apps/metafields/types). */
name?: boolean;
/** The supported validations for a metafield definition type. */
supportedValidations?: ValueTypes['MetafieldDefinitionSupportedValidation'];
/** Whether metafields without a definition can be migrated to a definition of this type. */
supportsDefinitionMigrations?: boolean;
/** The value type for a metafield created with this definition type. */
valueType?: boolean;
__typename?: boolean;
}>;
/** Return type for `metafieldDefinitionUnpin` mutation. */
['MetafieldDefinitionUnpinPayload']: AliasType<{
/** The metafield definition that was unpinned. */
unpinnedDefinition?: ValueTypes['MetafieldDefinition'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MetafieldDefinitionUnpinUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `MetafieldDefinitionUnpin`. */
['MetafieldDefinitionUnpinUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `MetafieldDefinitionUnpinUserError`. */
['MetafieldDefinitionUnpinUserErrorCode']: MetafieldDefinitionUnpinUserErrorCode;
/** Specifies the input fields that are required to update a metafield definition. */
['MetafieldDefinitionUpdateInput']: {
/** The namespace to group a metafield definition. */
namespace: string;
/** The key name used to identify a metafield definition within a namespace. */
key: string;
/** The human-readable name for the metafield definition. */
name?: string | null;
/** The description for the metafield definition. */
description?: string | null;
/** The resource type that the metafield definition is attached to. */
ownerType: ValueTypes['MetafieldOwnerType'];
/** Whether to pin the metafield definition. */
pin?: boolean | null;
};
/** Return type for `metafieldDefinitionUpdate` mutation. */
['MetafieldDefinitionUpdatePayload']: AliasType<{
/** The metafield definition that was updated. */
updatedDefinition?: ValueTypes['MetafieldDefinition'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MetafieldDefinitionUpdateUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `MetafieldDefinitionUpdate`. */
['MetafieldDefinitionUpdateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `MetafieldDefinitionUpdateUserError`. */
['MetafieldDefinitionUpdateUserErrorCode']: MetafieldDefinitionUpdateUserErrorCode;
/** A configured metafield definition validation.
For example, for a metafield definition of `number_integer` type, you can set a validation with the name `max`
and a value of `15`. This validation will ensure that the value of the metafield is a number less than or equal to 15.
Refer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types). */
['MetafieldDefinitionValidation']: AliasType<{
/** The validation name. */
name?: boolean;
/** The name for the metafield type of this validation. */
type?: boolean;
/** The validation value. */
value?: boolean;
__typename?: boolean;
}>;
/** The name and value for a metafield definition validation.
For example, for a metafield definition of `single_line_text_field` type, you can set a validation with the name `min` and a value of `10`.
This validation will ensure that the value of the metafield is at least 10 characters.
Refer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types). */
['MetafieldDefinitionValidationInput']: {
/** The name for the metafield definition validation. */
name: string;
/** The value for the metafield definition validation. */
value: string;
};
/** Possible metafield definition validation statuses. */
['MetafieldDefinitionValidationStatus']: MetafieldDefinitionValidationStatus;
/** Specifies the input fields to delete a metafield. */
['MetafieldDeleteInput']: {
/** The ID of the metafield to delete. */
id: string;
};
/** Return type for `metafieldDelete` mutation. */
['MetafieldDeletePayload']: AliasType<{
/** The ID of the deleted metafield. */
deletedId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Metafield and a cursor during pagination. */
['MetafieldEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of MetafieldEdge. */
node?: ValueTypes['Metafield'];
__typename?: boolean;
}>;
/** The input fields to use to create or update a metafield through a mutation on the owning resource.
An alternative way to create or update a metafield is by using the
[metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsSet) mutation. */
['MetafieldInput']: {
/** The description of the metafield. */
description?: string | null;
/** The unique ID of the metafield. You don't include an ID when you create a metafield because the metafield ID
is created automatically. The ID is required when you update a metafield. */
id?: string | null;
/** The namespace for a metafield. The namespace is required when you create a metafield and is optional when you
update a metafield. */
namespace?: string | null;
/** The key name of the metafield. Required when creating but optional when updating. */
key?: string | null;
/** The value of a metafield. */
value?: string | null;
/** The metafield's [type](https://shopify.dev/apps/metafields/types). The metafield type is required
when you create a metafield and is optional when you update a metafield. */
type?: string | null;
};
/** Possible types of a metafield's owner resource. */
['MetafieldOwnerType']: MetafieldOwnerType;
/** The resource referenced by the metafield value. */
['MetafieldReference']: AliasType<{
['...on GenericFile']: ValueTypes['GenericFile'];
['...on MediaImage']: ValueTypes['MediaImage'];
['...on OnlineStorePage']: ValueTypes['OnlineStorePage'];
['...on Product']: ValueTypes['Product'];
['...on ProductVariant']: ValueTypes['ProductVariant'];
__typename?: boolean;
}>;
/** By default, the Storefront API can't read metafields. To make specific metafields visible in the Storefront API,
you need to create a `MetafieldStorefrontVisibility` record. A `MetafieldStorefrontVisibility` record is a list
of the metafields, defined by the `owner_type`, `namespace`, and `key`, to make visible in the Storefront API.
See [expose metafields in the Storefront API](https://shopify.dev/custom-storefront/products/metafields#expose-metafields)
for more details. */
['MetafieldStorefrontVisibility']: AliasType<{
/** The date and time when the metafield was set to visible in the Storefront API. */
createdAt?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The key of a metafield to make visible in the Storefront API. */
key?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The namespace of a metafield to make visible in the Storefront API. */
namespace?: boolean;
/** The owner type of a metafield to make visible in the Storefront API. */
ownerType?: boolean;
/** The date and time when the `MetafieldStorefrontVisilibty` record was updated. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple MetafieldStorefrontVisibilities. */
['MetafieldStorefrontVisibilityConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['MetafieldStorefrontVisibilityEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `metafieldStorefrontVisibilityCreate` mutation. */
['MetafieldStorefrontVisibilityCreatePayload']: AliasType<{
/** The `MetafieldStorefrontVisibility` that was created. */
metafieldStorefrontVisibility?: ValueTypes['MetafieldStorefrontVisibility'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `metafieldStorefrontVisibilityDelete` mutation. */
['MetafieldStorefrontVisibilityDeletePayload']: AliasType<{
/** The ID of the deleted `MetafieldStorefrontVisibility` record. */
deletedMetafieldStorefrontVisibilityId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one MetafieldStorefrontVisibility and a cursor during pagination. */
['MetafieldStorefrontVisibilityEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of MetafieldStorefrontVisibilityEdge. */
node?: ValueTypes['MetafieldStorefrontVisibility'];
__typename?: boolean;
}>;
/** Specifies the input fields to create a `MetafieldStorefrontVisibility` record. */
['MetafieldStorefrontVisibilityInput']: {
/** The namespace of a metafield to make visible in the Storefront API. */
namespace: string;
/** The key of a metafield to make visible in the Storefront API. */
key: string;
/** The owner type of a metafield to make visible in the Storefront API. */
ownerType: ValueTypes['MetafieldOwnerType'];
};
/** Possible metafield validation statuses. */
['MetafieldValidationStatus']: MetafieldValidationStatus;
/** Legacy type information for the stored value.
Replaced by `type`. */
['MetafieldValueType']: MetafieldValueType;
/** Specifies the input fields for a metafield value to set. */
['MetafieldsSetInput']: {
/** The ID of the owner resource. */
ownerId: string;
/** A container for a group of metafields.
Grouping metafields in a namespace prevents your metafields from conflicting with other metafields that have the same key name. */
namespace: string;
/** The key name of the metafield. */
key: string;
/** The data to store in the metafield. The data is always stored as a string, regardless of the metafield's type. */
value: string;
/** The type of data that the metafield stores.
The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). */
type: string;
};
/** Return type for `metafieldsSet` mutation. */
['MetafieldsSetPayload']: AliasType<{
/** The list of metafields that were set. */
metafields?: ValueTypes['Metafield'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MetafieldsSetUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `MetafieldsSet`. */
['MetafieldsSetUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `MetafieldsSetUserError`. */
['MetafieldsSetUserErrorCode']: MetafieldsSetUserErrorCode;
/** The set of valid sort keys for the MethodDefinition query. */
['MethodDefinitionSortKeys']: MethodDefinitionSortKeys;
/** Represents a Shopify hosted 3D model. */
['Model3d']: AliasType<{
/** A word or phrase to share the nature or contents of a media. */
alt?: boolean;
/** The bounding box information of the 3d model. */
boundingBox?: ValueTypes['Model3dBoundingBox'];
/** The filename of the 3d model. */
filename?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The media content type. */
mediaContentType?: boolean;
/** Any errors which have occurred on the media. */
mediaErrors?: ValueTypes['MediaError'];
/** The warnings attached to the media. */
mediaWarnings?: ValueTypes['MediaWarning'];
/** The original source for a 3d model. */
originalSource?: ValueTypes['Model3dSource'];
/** The preview image for the media. */
preview?: ValueTypes['MediaPreviewImage'];
/** The sources for a 3d model. */
sources?: ValueTypes['Model3dSource'];
/** Current status of the media. */
status?: boolean;
__typename?: boolean;
}>;
/** Bounding box information of a 3d model. */
['Model3dBoundingBox']: AliasType<{
/** Size in meters of the smallest volume which contains the 3d model. */
size?: ValueTypes['Vector3'];
__typename?: boolean;
}>;
/** Represents a source for a Shopify hosted 3d model. */
['Model3dSource']: AliasType<{
/** The filesize of the 3d model. */
filesize?: boolean;
/** The format of the 3d model. */
format?: boolean;
/** The MIME type of the 3d model. */
mimeType?: boolean;
/** The URL of the 3d model. */
url?: boolean;
__typename?: boolean;
}>;
/** A monetary value string without a currency symbol or code. Example value: `"100.57"`. */
['Money']: unknown;
/** A collection of monetary values in their respective currencies. Typically used in the context of multi-currency pricing and transactions,
when an amount in the shop's currency is converted to the customer's currency of choice (the presentment currency). */
['MoneyBag']: AliasType<{
/** Amount in presentment currency. */
presentmentMoney?: ValueTypes['MoneyV2'];
/** Amount in shop currency. */
shopMoney?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** Specifies the fields for a monetary value with currency. */
['MoneyInput']: {
/** Decimal money amount. */
amount: ValueTypes['Decimal'];
/** Currency of the money. */
currencyCode: ValueTypes['CurrencyCode'];
};
/** A monetary value with currency. */
['MoneyV2']: AliasType<{
/** Decimal money amount. */
amount?: boolean;
/** Currency of the money. */
currencyCode?: boolean;
__typename?: boolean;
}>;
/** An individual move to perform of an object to a position. */
['MoveInput']: {
/** The ID of the object to be moved. */
id: string;
/** The new position of the object in the set, using a 0 based index. */
newPosition: ValueTypes['UnsignedInt64'];
};
/** The schema's entry point for all mutation operations. */
['Mutation']: AliasType<{
appCreditCreate?: [
{
/** The description of the app credit. */
description: string /** The amount that can be used towards future app purchases in Shopify.The only permitted currency code is USD. */;
amount: ValueTypes['MoneyInput'] /** Specifies whether the app credit is a test transaction. */;
test?: boolean | null;
},
ValueTypes['AppCreditCreatePayload']
];
appPurchaseOneTimeCreate?: [
{
/** The name of the one-time purchase from the app. */
name: string /** The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD. */;
price: ValueTypes['MoneyInput'] /** The URL where the merchant is redirected after approving the app one-time purchase. */;
returnUrl: ValueTypes['URL'] /** Whether the app one-time purchase is a test transaction. The default value is `false`. */;
test?: boolean | null;
},
ValueTypes['AppPurchaseOneTimeCreatePayload']
];
appRevenueAttributionRecordCreate?: [
{
/** The app revenue attribution record to be created. */
appRevenueAttributionRecord: ValueTypes['AppRevenueAttributionRecordInput'];
},
ValueTypes['AppRevenueAttributionRecordCreatePayload']
];
appRevenueAttributionRecordDelete?: [
{
/** The unique identifier of the revenue attribution record. */
id: string;
},
ValueTypes['AppRevenueAttributionRecordDeletePayload']
];
appSubscriptionCancel?: [
{
/** The ID of the app subscription to be cancelled. */
id: string;
},
ValueTypes['AppSubscriptionCancelPayload']
];
appSubscriptionCreate?: [
{
/** A descriptive name for the app subscription. */
name: string /** Attaches one or more pricing plans to an app subscription. Only one pricing plan can be defined for each available type. */;
lineItems: ValueTypes['AppSubscriptionLineItemInput'][] /** Whether the app subscription is a test transaction. The default value is `false`. */;
test?: boolean | null /** The number of days of the free trial period, beginning on the day that the merchant approves the app charges. */;
trialDays?: number | null /** The URL pointing to the page where the merchant is redirected after approving the app subscription. */;
returnUrl: ValueTypes['URL'];
},
ValueTypes['AppSubscriptionCreatePayload']
];
appSubscriptionLineItemUpdate?: [
{
/** The ID of the app subscription line item to be updated. */
id: string /** The new maximum amount of usage charges that can be incurred within a subscription billing interval. */;
cappedAmount: ValueTypes['MoneyInput'];
},
ValueTypes['AppSubscriptionLineItemUpdatePayload']
];
appUsageRecordCreate?: [
{
/** The ID of the app subscription line item to create the usage record under. This app subscription line item must have a usage pricing plan. */
subscriptionLineItemId: string /** The price of the app usage record. The only permitted currceny code is USD. */;
price: ValueTypes['MoneyInput'] /** The description of the app usage record. */;
description: string;
},
ValueTypes['AppUsageRecordCreatePayload']
];
bulkOperationCancel?: [
{
/** The ID of the bulk operation to cancel. */
id: string;
},
ValueTypes['BulkOperationCancelPayload']
];
bulkOperationRunMutation?: [
{
/** The mutation to be executed in bulk. */
mutation: string /** The staged upload path of the file containing mutation variables. */;
stagedUploadPath: string /** An optional identifier which may be used for querying. */;
clientIdentifier?: string | null;
},
ValueTypes['BulkOperationRunMutationPayload']
];
bulkOperationRunQuery?: [
{
/** The query to be executed in bulk. */
query: string;
},
ValueTypes['BulkOperationRunQueryPayload']
];
bulkProductResourceFeedbackCreate?: [
{
/** An array of inputs to create the feedback. Limited to 50. */
feedbackInput: ValueTypes['ProductResourceFeedbackInput'][];
},
ValueTypes['BulkProductResourceFeedbackCreatePayload']
];
collectionAddProducts?: [
{
/** The ID of the collection that's being updated. */
id: string /** The IDs of the products that are being added to the collection. */;
productIds: string[];
},
ValueTypes['CollectionAddProductsPayload']
];
collectionCreate?: [
{
/** The properties to use when creating the collection. */
input: ValueTypes['CollectionInput'];
},
ValueTypes['CollectionCreatePayload']
];
collectionDelete?: [
{
/** Specifies the collection to delete by its ID. */
input: ValueTypes['CollectionDeleteInput'];
},
ValueTypes['CollectionDeletePayload']
];
collectionPublish?: [
{
/** Specify a collection to publish and the sales channels to publish it to. */
input: ValueTypes['CollectionPublishInput'];
},
ValueTypes['CollectionPublishPayload']
];
collectionRemoveProducts?: [
{
/** The ID of the collection to remove products from. */
id: string /** The IDs of products to remove from the collection. */;
productIds: string[];
},
ValueTypes['CollectionRemoveProductsPayload']
];
collectionReorderProducts?: [
{
/** The ID of the collection on which to reorder products. */
id: string /** A list of moves to perform which will be evaulated in order. */;
moves: ValueTypes['MoveInput'][];
},
ValueTypes['CollectionReorderProductsPayload']
];
collectionUnpublish?: [
{
/** Specify a collection to unpublish and the sales channels to remove it from. */
input: ValueTypes['CollectionUnpublishInput'];
},
ValueTypes['CollectionUnpublishPayload']
];
collectionUpdate?: [
{
/** The updated properties for the collection. */
input: ValueTypes['CollectionInput'];
},
ValueTypes['CollectionUpdatePayload']
];
customerAddTaxExemptions?: [
{
/** The ID of the customer to update. */
customerId: string /** The list of tax exemptions to add for the customer, in the format of an array or a comma-separated list. Example values: `["CA_BC_RESELLER_EXEMPTION", A_STATUS_CARD_EXEMPTION"]`, `"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION)"`. */;
taxExemptions: ValueTypes['TaxExemption'][];
},
ValueTypes['CustomerAddTaxExemptionsPayload']
];
customerCreate?: [
{
/** The input fields to create a customer. */
input: ValueTypes['CustomerInput'];
},
ValueTypes['CustomerCreatePayload']
];
customerDelete?: [
{
/** Specifies the customer to delete. */
input: ValueTypes['CustomerDeleteInput'];
},
ValueTypes['CustomerDeletePayload']
];
customerGenerateAccountActivationUrl?: [
{
/** The ID of the customer that the URL is generated for. */
customerId: string;
},
ValueTypes['CustomerGenerateAccountActivationUrlPayload']
];
customerPaymentMethodCreditCardCreate?: [
{
/** The ID of the customer. */
customerId: string /** The billing address. */;
billingAddress: ValueTypes['MailingAddressInput'] /** The Cardserver session ID. */;
sessionId: string;
},
ValueTypes['CustomerPaymentMethodCreditCardCreatePayload']
];
customerPaymentMethodCreditCardUpdate?: [
{
/** The ID of the customer payment method. */
id: string /** The billing address. */;
billingAddress: ValueTypes['MailingAddressInput'] /** The Cardserver session ID. */;
sessionId: string;
},
ValueTypes['CustomerPaymentMethodCreditCardUpdatePayload']
];
customerPaymentMethodGetUpdateUrl?: [
{
/** The payment method to be updated. */
customerPaymentMethodId: string;
},
ValueTypes['CustomerPaymentMethodGetUpdateUrlPayload']
];
customerPaymentMethodPaypalBillingAgreementCreate?: [
{
/** The ID of the customer. */
customerId: string /** The billing address. */;
billingAddress?: ValueTypes['MailingAddressInput'] | null /** The billing agreement ID from PayPal. */;
billingAgreementId: string /** Whether the PayPal billing agreement is inactive. */;
inactive?: boolean | null;
},
ValueTypes['CustomerPaymentMethodPaypalBillingAgreementCreatePayload']
];
customerPaymentMethodPaypalBillingAgreementUpdate?: [
{
/** The ID of the customer payment method. */
id: string /** The billing address. */;
billingAddress: ValueTypes['MailingAddressInput'];
},
ValueTypes['CustomerPaymentMethodPaypalBillingAgreementUpdatePayload']
];
customerPaymentMethodRemoteCreate?: [
{
/** The ID of the customer. */
customerId: string /** Remote gateway payment method details. */;
remoteReference: ValueTypes['CustomerPaymentMethodRemoteInput'];
},
ValueTypes['CustomerPaymentMethodRemoteCreatePayload']
];
customerPaymentMethodRemoteCreditCardCreate?: [
{
/** The ID of the customer. */
customerId: string /** The Stripe Customer ID. */;
stripeCustomerId: string /** The Stripe Payment Method ID. */;
stripePaymentMethodId?: string | null;
},
ValueTypes['CustomerPaymentMethodRemoteCreditCardCreatePayload']
];
customerPaymentMethodRevoke?: [
{
/** The ID of the customer payment method to be revoked. */
customerPaymentMethodId: string;
},
ValueTypes['CustomerPaymentMethodRevokePayload']
];
customerPaymentMethodSendUpdateEmail?: [
{
/** The payment method to be updated. */
customerPaymentMethodId: string /** Specifies the payment method update email fields. */;
email?: ValueTypes['EmailInput'] | null;
},
ValueTypes['CustomerPaymentMethodSendUpdateEmailPayload']
];
customerRemoveTaxExemptions?: [
{
/** The ID of the customer to update. */
customerId: string /** The list of tax exemptions to remove for the customer, in the format of an array or a comma-separated list. Example values: `["CA_BC_RESELLER_EXEMPTION", A_STATUS_CARD_EXEMPTION"]`, `"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION"`. */;
taxExemptions: ValueTypes['TaxExemption'][];
},
ValueTypes['CustomerRemoveTaxExemptionsPayload']
];
customerReplaceTaxExemptions?: [
{
/** The ID of the customer to update. */
customerId: string /** The list of tax exemptions that will replace the current exemptions for a customer. Can be an array or a comma-separated list.
Example values: `["CA_BC_RESELLER_EXEMPTION", "A_STATUS_CARD_EXEMPTION"]`, `"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION"`. */;
taxExemptions: ValueTypes['TaxExemption'][];
},
ValueTypes['CustomerReplaceTaxExemptionsPayload']
];
customerSmsMarketingConsentUpdate?: [
{
/** Specifies the input fields to update a customer's SMS marketing consent information. */
input: ValueTypes['CustomerSmsMarketingConsentUpdateInput'];
},
ValueTypes['CustomerSmsMarketingConsentUpdatePayload']
];
customerUpdate?: [
{
/** Provides updated fields for the customer. */
input: ValueTypes['CustomerInput'];
},
ValueTypes['CustomerUpdatePayload']
];
customerUpdateDefaultAddress?: [
{
/** The ID of the customer whose default address is being updated. */
customerId: string /** The ID of the customer's new default address. */;
addressId: string;
},
ValueTypes['CustomerUpdateDefaultAddressPayload']
];
deliveryProfileCreate?: [
{
/** Specifies the input fields for a delivery profile. */
profile: ValueTypes['DeliveryProfileInput'];
},
ValueTypes['deliveryProfileCreatePayload']
];
deliveryProfileRemove?: [
{
/** The ID of the delivery profile to remove. */
id: string;
},
ValueTypes['deliveryProfileRemovePayload']
];
deliveryProfileUpdate?: [
{
/** The ID of the delivery profile to update. */
id: string /** Specifies the input fields for a delivery profile. */;
profile: ValueTypes['DeliveryProfileInput'] /** Whether this delivery profile should leave legacy mode. */;
leaveLegacyModeProfiles?: boolean | null;
},
ValueTypes['deliveryProfileUpdatePayload']
];
deliverySettingUpdate?: [
{
/** Specifies the input fields for the delivery shop level settings. */
setting: ValueTypes['DeliverySettingInput'];
},
ValueTypes['DeliverySettingUpdatePayload']
];
deliveryShippingOriginAssign?: [
{
/** The ID of the location to assign as the shipping origin. */
locationId: string;
},
ValueTypes['DeliveryShippingOriginAssignPayload']
];
discountAutomaticActivate?: [
{
/** The ID of the automatic discount to activate. */
id: string;
},
ValueTypes['DiscountAutomaticActivatePayload']
];
discountAutomaticBasicCreate?: [
{
/** The input data used to create the automatic discount. */
automaticBasicDiscount: ValueTypes['DiscountAutomaticBasicInput'];
},
ValueTypes['DiscountAutomaticBasicCreatePayload']
];
discountAutomaticBasicUpdate?: [
{
/** The ID of the automatic discount to update. */
id: string /** The input data used to update the automatic discount. */;
automaticBasicDiscount: ValueTypes['DiscountAutomaticBasicInput'];
},
ValueTypes['DiscountAutomaticBasicUpdatePayload']
];
discountAutomaticBulkDelete?: [
{
/** The search query for filtering automatic discounts on. */
search?: string | null /** The ID of the saved search. */;
savedSearchId?: string | null /** The IDs of the automatic discounts to delete. */;
ids?: string[];
},
ValueTypes['DiscountAutomaticBulkDeletePayload']
];
discountAutomaticBxgyCreate?: [
{
/** The input data used to create the automatic discount. */
automaticBxgyDiscount: ValueTypes['DiscountAutomaticBxgyInput'];
},
ValueTypes['DiscountAutomaticBxgyCreatePayload']
];
discountAutomaticBxgyUpdate?: [
{
/** The ID of the automatic discount to update. */
id: string /** The input data used to update the automatic discount. */;
automaticBxgyDiscount: ValueTypes['DiscountAutomaticBxgyInput'];
},
ValueTypes['DiscountAutomaticBxgyUpdatePayload']
];
discountAutomaticDeactivate?: [
{
/** The ID of the automatic discount to update. */
id: string;
},
ValueTypes['DiscountAutomaticDeactivatePayload']
];
discountAutomaticDelete?: [
{
/** The ID of the automatic discount to delete. */
id: string;
},
ValueTypes['DiscountAutomaticDeletePayload']
];
discountCodeActivate?: [
{
/** The ID of the code discount to activate. */
id: string;
},
ValueTypes['DiscountCodeActivatePayload']
];
discountCodeBasicCreate?: [
{
/** The input data used to create the code discount. */
basicCodeDiscount: ValueTypes['DiscountCodeBasicInput'];
},
ValueTypes['DiscountCodeBasicCreatePayload']
];
discountCodeBasicUpdate?: [
{
/** The ID of the code discount to update. */
id: string /** The input data used to update the code discount. */;
basicCodeDiscount: ValueTypes['DiscountCodeBasicInput'];
},
ValueTypes['DiscountCodeBasicUpdatePayload']
];
discountCodeBulkActivate?: [
{
/** The search query for filtering discounts. */
search?: string | null /** The ID of the saved search. */;
savedSearchId?: string | null /** The IDs of the code discounts to activate. */;
ids?: string[];
},
ValueTypes['DiscountCodeBulkActivatePayload']
];
discountCodeBulkDeactivate?: [
{
/** The search query for filtering discounts. */
search?: string | null /** The ID of the saved search. */;
savedSearchId?: string | null /** The IDs of the code discounts to deactivate. */;
ids?: string[];
},
ValueTypes['DiscountCodeBulkDeactivatePayload']
];
discountCodeBulkDelete?: [
{
/** The search query for filtering discounts. */
search?: string | null /** The ID of the saved search retrieved from the `priceRuleSavedSearches` query node. */;
savedSearchId?: string | null /** The IDs of the code discounts to delete. */;
ids?: string[];
},
ValueTypes['DiscountCodeBulkDeletePayload']
];
discountCodeBxgyCreate?: [
{
/** The input data used to create the code discount. */
bxgyCodeDiscount: ValueTypes['DiscountCodeBxgyInput'];
},
ValueTypes['DiscountCodeBxgyCreatePayload']
];
discountCodeBxgyUpdate?: [
{
/** The ID of the code discount to update. */
id: string /** The input data used to update the code discount. */;
bxgyCodeDiscount: ValueTypes['DiscountCodeBxgyInput'];
},
ValueTypes['DiscountCodeBxgyUpdatePayload']
];
discountCodeDeactivate?: [
{
/** The ID of the code discount to deactivate. */
id: string;
},
ValueTypes['DiscountCodeDeactivatePayload']
];
discountCodeDelete?: [
{
/** The ID of the code discount to delete. */
id: string;
},
ValueTypes['DiscountCodeDeletePayload']
];
discountCodeFreeShippingCreate?: [
{
/** The input data used to create the code discount. */
freeShippingCodeDiscount: ValueTypes['DiscountCodeFreeShippingInput'];
},
ValueTypes['DiscountCodeFreeShippingCreatePayload']
];
discountCodeFreeShippingUpdate?: [
{
/** The ID of the code discount to update. */
id: string /** The input data used to update the code discount. */;
freeShippingCodeDiscount: ValueTypes['DiscountCodeFreeShippingInput'];
},
ValueTypes['DiscountCodeFreeShippingUpdatePayload']
];
discountCodeRedeemCodeBulkDelete?: [
{
/** The ID of the redeem code's discount. */
discountId: string /** The search query for filtering discount redeem codes. */;
search?: string | null /** The ID of the saved search. */;
savedSearchId?: string | null /** The IDs of the discount redeem codes to delete. */;
ids?: string[];
},
ValueTypes['DiscountCodeRedeemCodeBulkDeletePayload']
];
discountRedeemCodeBulkAdd?: [
{
/** The ID of the code discount that the codes will be added to. */
discountId: string /** The list of codes that will be added to the code discount. Maximum 100 codes permitted. */;
codes: ValueTypes['DiscountRedeemCodeInput'][];
},
ValueTypes['DiscountRedeemCodeBulkAddPayload']
];
draftOrderCalculate?: [
{
/** The fields for the draft order. */
input: ValueTypes['DraftOrderInput'];
},
ValueTypes['DraftOrderCalculatePayload']
];
draftOrderComplete?: [
{
/** Specifies the draft order to complete. */
id: string /** Specifies whether the payment is pending or not. */;
paymentPending?: boolean | null;
},
ValueTypes['DraftOrderCompletePayload']
];
draftOrderCreate?: [
{
/** The fields used to create the draft order. */
input: ValueTypes['DraftOrderInput'];
},
ValueTypes['DraftOrderCreatePayload']
];
draftOrderDelete?: [
{
/** Specify the draft order to delete by its ID. */
input: ValueTypes['DraftOrderDeleteInput'];
},
ValueTypes['DraftOrderDeletePayload']
];
draftOrderInvoicePreview?: [
{
/** Specifies the draft order invoice email to preview. */
id: string /** Specifies the draft order invoice email fields. */;
email?: ValueTypes['EmailInput'] | null;
},
ValueTypes['DraftOrderInvoicePreviewPayload']
];
draftOrderInvoiceSend?: [
{
/** Specifies the draft order to send the invoice for. */
id: string /** Specifies the draft order invoice email fields. */;
email?: ValueTypes['EmailInput'] | null;
},
ValueTypes['DraftOrderInvoiceSendPayload']
];
draftOrderUpdate?: [
{
/** Specifies the draft order to update. */
id: string /** The draft order properties to update. */;
input: ValueTypes['DraftOrderInput'];
},
ValueTypes['DraftOrderUpdatePayload']
];
eventBridgeWebhookSubscriptionCreate?: [
{
/** The type of event that triggers the webhook. */
topic: ValueTypes['WebhookSubscriptionTopic'] /** Specifies the input fields for an EventBridge webhook subscription. */;
webhookSubscription: ValueTypes['EventBridgeWebhookSubscriptionInput'];
},
ValueTypes['EventBridgeWebhookSubscriptionCreatePayload']
];
eventBridgeWebhookSubscriptionUpdate?: [
{
/** The ID of the webhook subscription to update. */
id: string /** Specifies the input fields for an EventBridge webhook subscription. */;
webhookSubscription: ValueTypes['EventBridgeWebhookSubscriptionInput'];
},
ValueTypes['EventBridgeWebhookSubscriptionUpdatePayload']
];
fileCreate?: [
{
/** List of new files to be created. */
files: ValueTypes['FileCreateInput'][];
},
ValueTypes['FileCreatePayload']
];
fileDelete?: [
{
/** The IDs of the files to be deleted. */
fileIds: string[];
},
ValueTypes['FileDeletePayload']
];
fileUpdate?: [
{
/** List of files to be updated. */
files: ValueTypes['FileUpdateInput'][];
},
ValueTypes['FileUpdatePayload']
];
flowTriggerReceive?: [
{
/** The payload needed to run the Trigger. */
body: string;
},
ValueTypes['FlowTriggerReceivePayload']
];
fulfillmentCancel?: [
{
/** The ID of the fulfillment to be canceled. */
id: string;
},
ValueTypes['FulfillmentCancelPayload']
];
fulfillmentCreate?: [
{
/** The input fields used to create a fulfillment. */
input: ValueTypes['FulfillmentInput'];
},
ValueTypes['FulfillmentCreatePayload']
];
fulfillmentCreateV2?: [
{
/** The input fields used to create a fulfillment from fulfillment orders. */
fulfillment: ValueTypes['FulfillmentV2Input'] /** An optional message for the fulfillment request. */;
message?: string | null;
},
ValueTypes['FulfillmentCreateV2Payload']
];
fulfillmentOrderAcceptCancellationRequest?: [
{
/** The ID of the fulfillment order associated with the cancellation request. */
id: string /** An optional reason for accepting the cancellation request. */;
message?: string | null;
},
ValueTypes['FulfillmentOrderAcceptCancellationRequestPayload']
];
fulfillmentOrderAcceptFulfillmentRequest?: [
{
/** The ID of the fulfillment order associated with the fulfillment request. */
id: string /** An optional reason for accepting the fulfillment request. */;
message?: string | null;
},
ValueTypes['FulfillmentOrderAcceptFulfillmentRequestPayload']
];
fulfillmentOrderCancel?: [
{
/** The ID of the fulfillment order to mark as canceled. */
id: string;
},
ValueTypes['FulfillmentOrderCancelPayload']
];
fulfillmentOrderClose?: [
{
/** The ID of the fulfillment order to mark as incomplete. */
id: string /** An optional reason for marking the fulfillment order as incomplete. */;
message?: string | null;
},
ValueTypes['FulfillmentOrderClosePayload']
];
fulfillmentOrderHold?: [
{
/** The ID of the fulfillment order on which a fulfillment hold is applied. */
id: string /** The details of the fulfillment hold applied on the fulfillment order. */;
fulfillmentHold: ValueTypes['FulfillmentOrderHoldInput'];
},
ValueTypes['FulfillmentOrderHoldPayload']
];
fulfillmentOrderMove?: [
{
/** The ID of the fulfillment order to be moved. */
id: string /** The ID of the location where the fulfillment order will be moved. */;
newLocationId: string;
},
ValueTypes['FulfillmentOrderMovePayload']
];
fulfillmentOrderOpen?: [
{
/** The ID of the fulfillment order to mark as open. */
id: string;
},
ValueTypes['FulfillmentOrderOpenPayload']
];
fulfillmentOrderRejectCancellationRequest?: [
{
/** The ID of the fulfillment order associated with the cancellation request. */
id: string /** An optional reason for rejecting the cancellation request. */;
message?: string | null;
},
ValueTypes['FulfillmentOrderRejectCancellationRequestPayload']
];
fulfillmentOrderRejectFulfillmentRequest?: [
{
/** The ID of the fulfillment order associated with the fulfillment request. */
id: string /** An optional reason for rejecting the fulfillment request. */;
message?: string | null;
},
ValueTypes['FulfillmentOrderRejectFulfillmentRequestPayload']
];
fulfillmentOrderReleaseHold?: [
{
/** The ID of the fulfillment order for which to release the fulfillment hold. */
id: string;
},
ValueTypes['FulfillmentOrderReleaseHoldPayload']
];
fulfillmentOrderReschedule?: [
{
/** The ID of the fulfillment order to reschedule. */
id: string /** The new fulfill at date of the fulfillment order. */;
fulfillAt: ValueTypes['DateTime'];
},
ValueTypes['FulfillmentOrderReschedulePayload']
];
fulfillmentOrderSubmitCancellationRequest?: [
{
/** The ID of the fulfillment order associated with the cancellation request. */
id: string /** An optional reason for the cancellation request. */;
message?: string | null;
},
ValueTypes['FulfillmentOrderSubmitCancellationRequestPayload']
];
fulfillmentOrderSubmitFulfillmentRequest?: [
{
/** The ID of the fulfillment order associated with fulfillment request. */
id: string /** An optional message for the fulfillment request. */;
message?: string | null /** Whether the customer should be notified when fulfillments are created for this fulfillment order. */;
notifyCustomer?: boolean | null /** The fulfillment order line items to be requested for fulfillment.
If left blank, all line items of the fulfillment order are requested for fulfillment. */;
fulfillmentOrderLineItems?: ValueTypes['FulfillmentOrderLineItemInput'][] /** A reference to the [ShippingMethod](https://shopify.dev/api/admin-graphql/latest/objects/shippingmethod) code, such as `FREE_SHIPPING`. */;
shippingMethod?: string | null;
},
ValueTypes['FulfillmentOrderSubmitFulfillmentRequestPayload']
];
fulfillmentServiceCreate?: [
{
/** The name of the fulfillment service. */
name: string /** The URL to send requests for the fulfillment service. */;
callbackUrl?: ValueTypes['URL'] | null /** Whether the fulfillment service provides tracking numbers for packages. */;
trackingSupport?:
| boolean
| null /** Whether the fulfillment service will use the new fulfillment request flow based on fulfillment orders. */;
fulfillmentOrdersOptIn?: boolean | null /** Whether the fulfillment service manages product inventory and provides updates to Shopify. */;
inventoryManagement?: boolean | null;
},
ValueTypes['FulfillmentServiceCreatePayload']
];
fulfillmentServiceDelete?: [
{
/** The ID of the fulfillment service to delete. */
id: string /** The ID of the location where inventory and commitments will be relocated
after the fulfillment service is deleted. */;
destinationLocationId?: string | null;
},
ValueTypes['FulfillmentServiceDeletePayload']
];
fulfillmentServiceUpdate?: [
{
/** The id of the fulfillment service. */
id: string /** The name of the fulfillment service. */;
name?: string | null /** The URL to send requests for the fulfillment service. */;
callbackUrl?: ValueTypes['URL'] | null /** Whether the fulfillment service provides tracking numbers for packages. */;
trackingSupport?:
| boolean
| null /** Whether the fulfillment service will use the new fulfillment request flow based on fulfillment orders. */;
fulfillmentOrdersOptIn?: boolean | null;
},
ValueTypes['FulfillmentServiceUpdatePayload']
];
fulfillmentTrackingInfoUpdate?: [
{
/** The id of the fulfillment. */
fulfillmentId: string /** The input for the mutation. */;
trackingInfoUpdateInput: ValueTypes['TrackingInfoUpdateInput'];
},
ValueTypes['FulfillmentTrackingInfoUpdatePayload']
];
fulfillmentTrackingInfoUpdateV2?: [
{
/** The ID of the fulfillment. */
fulfillmentId: string /** The tracking input for the mutation, including tracking URL, number, and company. */;
trackingInfoInput: ValueTypes['FulfillmentTrackingInput'] /** Whether the customer will be notified of this update and future updates for the fulfillment.
If this field is left blank, then notifications won't be sent to the customer when the fulfillment is updated. */;
notifyCustomer?: boolean | null;
},
ValueTypes['FulfillmentTrackingInfoUpdateV2Payload']
];
giftCardCreate?: [
{
/** The input fields to create a gift card. */
input: ValueTypes['GiftCardCreateInput'];
},
ValueTypes['GiftCardCreatePayload']
];
giftCardDisable?: [
{
/** The ID of the gift card to disable. */
id: string;
},
ValueTypes['GiftCardDisablePayload']
];
giftCardUpdate?: [
{
/** The ID of the gift card to be updated. */
id: string /** The input fields to update the gift card. */;
input: ValueTypes['GiftCardUpdateInput'];
},
ValueTypes['GiftCardUpdatePayload']
];
inventoryActivate?: [
{
/** The ID of the inventory item to activate. */
inventoryItemId: string /** The ID of the location of the inventory item being activated. */;
locationId: string /** The initial available quantity of the inventory item being activated at the location. */;
available?: number | null;
},
ValueTypes['InventoryActivatePayload']
];
inventoryAdjustQuantity?: [
{
/** Provides the input fields required to update an inventory level. */
input: ValueTypes['InventoryAdjustQuantityInput'];
},
ValueTypes['InventoryAdjustQuantityPayload']
];
inventoryBulkAdjustQuantityAtLocation?: [
{
/** Specifies adjustments for items. */
inventoryItemAdjustments: ValueTypes['InventoryAdjustItemInput'][] /** Specifies where the item should be adjusted. */;
locationId: string;
},
ValueTypes['InventoryBulkAdjustQuantityAtLocationPayload']
];
inventoryDeactivate?: [
{
/** The ID of the inventory level to deactivate. */
inventoryLevelId: string;
},
ValueTypes['InventoryDeactivatePayload']
];
inventoryItemUpdate?: [
{
/** The ID of the inventory item to update. */
id: string /** The input fields that update an [`inventoryItem`](https://shopify.dev/api/admin-graphql/latest/queries/inventoryitem). */;
input: ValueTypes['InventoryItemUpdateInput'];
},
ValueTypes['InventoryItemUpdatePayload']
];
marketingActivityCreate?: [
{
/** The Input of marketing activity create. */
input: ValueTypes['MarketingActivityCreateInput'];
},
ValueTypes['MarketingActivityCreatePayload']
];
marketingActivityUpdate?: [
{
/** The Input of the marketing activity. */
input: ValueTypes['MarketingActivityUpdateInput'];
},
ValueTypes['MarketingActivityUpdatePayload']
];
marketingEngagementCreate?: [
{
/** The id of marketing activity. */
marketingActivityId: string /** The marketing engagement's attributes. */;
marketingEngagement: ValueTypes['MarketingEngagementInput'];
},
ValueTypes['MarketingEngagementCreatePayload']
];
metafieldDefinitionCreate?: [
{
/** Specifies the input fields for a metafield definition. */
definition: ValueTypes['MetafieldDefinitionInput'];
},
ValueTypes['MetafieldDefinitionCreatePayload']
];
metafieldDefinitionDelete?: [
{
/** The id of the metafield definition to delete. */
id: string /** Whether to delete all associated metafields. */;
deleteAllAssociatedMetafields?: boolean | null;
},
ValueTypes['MetafieldDefinitionDeletePayload']
];
metafieldDefinitionPin?: [
{
/** The ID of the metafield definition to pin. */
definitionId: string;
},
ValueTypes['MetafieldDefinitionPinPayload']
];
metafieldDefinitionUnpin?: [
{
/** The ID of the metafield definition to unpin. */
definitionId: string;
},
ValueTypes['MetafieldDefinitionUnpinPayload']
];
metafieldDefinitionUpdate?: [
{
/** The input fields for the metafield definition update. */
definition: ValueTypes['MetafieldDefinitionUpdateInput'];
},
ValueTypes['MetafieldDefinitionUpdatePayload']
];
metafieldDelete?: [{ input: ValueTypes['MetafieldDeleteInput'] }, ValueTypes['MetafieldDeletePayload']];
metafieldStorefrontVisibilityCreate?: [
{
/** Specifies the input fields for a `MetafieldStorefrontVisibility` record. */
input: ValueTypes['MetafieldStorefrontVisibilityInput'];
},
ValueTypes['MetafieldStorefrontVisibilityCreatePayload']
];
metafieldStorefrontVisibilityDelete?: [
{
/** The ID of the `MetafieldStorefrontVisibility` record to delete. */
id: string;
},
ValueTypes['MetafieldStorefrontVisibilityDeletePayload']
];
metafieldsSet?: [
{
/** The list of metafield values to set. Maximum of 25. */
metafields: ValueTypes['MetafieldsSetInput'][];
},
ValueTypes['MetafieldsSetPayload']
];
orderCapture?: [
{
/** The input for the mutation. */
input: ValueTypes['OrderCaptureInput'];
},
ValueTypes['OrderCapturePayload']
];
orderClose?: [
{
/** The input for the mutation. */
input: ValueTypes['OrderCloseInput'];
},
ValueTypes['OrderClosePayload']
];
orderEditAddCustomItem?: [
{
/** The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)
to which the custom item is added. */
id: string /** The name of the custom item to add. */;
title: string /** The ID of the retail [location](https://shopify.dev/api/admin-graphql/latest/objects/location)
(if applicable) from which the custom item is sold. Used for tax calculations. A default location will be chosen automatically if none is provided. */;
locationId?: string | null /** The unit price of the custom item. This value can't be negative. */;
price: ValueTypes['MoneyInput'] /** The quantity of the custom item. This value must be greater than zero. */;
quantity: number /** Whether the custom item is taxable. Defaults to `true`. */;
taxable?: boolean | null /** Whether the custom item requires shipping. Defaults to `false`. */;
requiresShipping?: boolean | null;
},
ValueTypes['OrderEditAddCustomItemPayload']
];
orderEditAddLineItemDiscount?: [
{
/** The ID of the calculated order to update. */
id: string /** The ID of a newly added calculated line item to add the discount to. */;
lineItemId: string /** The discount to add to the line item. */;
discount: ValueTypes['OrderEditAppliedDiscountInput'];
},
ValueTypes['OrderEditAddLineItemDiscountPayload']
];
orderEditAddVariant?: [
{
/** The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)
to edit. */
id: string /** The ID of the variant to add. */;
variantId: string /** The ID of the [location](https://shopify.dev/api/admin-graphql/latest/objects/location)
to check for inventory availability. A default location ID is chosen automatically if none is provided. */;
locationId?: string | null /** The quantity of the item to add to the order. Must be a positive value. */;
quantity: number /** Whether this mutation can create a line item for a variant that's already on the calculated order. */;
allowDuplicates?: boolean | null;
},
ValueTypes['OrderEditAddVariantPayload']
];
orderEditBegin?: [
{
/** The ID of the order to begin editing. */
id: string;
},
ValueTypes['OrderEditBeginPayload']
];
orderEditCommit?: [
{
/** The ID of the calculated order that will have its changes applied to the order. */
id: string /** Whether to notify the customer or not. */;
notifyCustomer?: boolean | null /** Note for staff members. */;
staffNote?: string | null;
},
ValueTypes['OrderEditCommitPayload']
];
orderEditRemoveLineItemDiscount?: [
{
/** The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)
from which to remove the discount. */
id: string /** The ID of the [calculated discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/calculateddiscountapplication)
to remove. */;
discountApplicationId: string;
},
ValueTypes['OrderEditRemoveLineItemDiscountPayload']
];
orderEditSetQuantity?: [
{
/** The ID of the calculated order to edit. The edit changes the quantity on the line item. */
id: string /** The ID of the line item to edit. */;
lineItemId: string /** The new quantity to set for the line item. This value cannot be negative. */;
quantity: number /** Whether or not to restock the line item when the updated quantity is less than the original quantity. */;
restock?: boolean | null;
},
ValueTypes['OrderEditSetQuantityPayload']
];
orderInvoiceSend?: [
{
/** The order associated with the invoice. */
id: string /** The email input fields for the order invoice. */;
email?: ValueTypes['EmailInput'] | null;
},
ValueTypes['OrderInvoiceSendPayload']
];
orderMarkAsPaid?: [
{
/** The input for the mutation. */
input: ValueTypes['OrderMarkAsPaidInput'];
},
ValueTypes['OrderMarkAsPaidPayload']
];
orderOpen?: [
{
/** The input for the mutation. */
input: ValueTypes['OrderOpenInput'];
},
ValueTypes['OrderOpenPayload']
];
orderUpdate?: [
{
/** The input for the mutation. */
input: ValueTypes['OrderInput'];
},
ValueTypes['OrderUpdatePayload']
];
paymentTermsCreate?: [
{
/** Specifies the reference to add the payment terms for. */
referenceId: string /** The attributes used to create the payment terms. */;
paymentTermsAttributes: ValueTypes['PaymentTermsCreateInput'];
},
ValueTypes['PaymentTermsCreatePayload']
];
paymentTermsDelete?: [
{
/** The input fields used to delete the payment terms. */
input: ValueTypes['PaymentTermsDeleteInput'];
},
ValueTypes['PaymentTermsDeletePayload']
];
paymentTermsUpdate?: [
{
/** The input fields used to update the payment terms. */
input: ValueTypes['PaymentTermsUpdateInput'];
},
ValueTypes['PaymentTermsUpdatePayload']
];
priceListCreate?: [
{
/** The properties of the new price list. */
input: ValueTypes['PriceListCreateInput'];
},
ValueTypes['PriceListCreatePayload']
];
priceListDelete?: [
{
/** The ID for the price list to be deleted. */
id: string;
},
ValueTypes['PriceListDeletePayload']
];
priceListFixedPricesAdd?: [
{
/** The ID of the price list to which the fixed prices will be added or updated. */
priceListId: string /** The list of fixed prices to add or update in the price list. */;
prices: ValueTypes['PriceListPriceInput'][];
},
ValueTypes['PriceListFixedPricesAddPayload']
];
priceListFixedPricesDelete?: [
{
/** The ID of the price list from which the fixed prices will be removed. */
priceListId: string /** A list of product variant IDs whose fixed prices will be removed from the price list. */;
variantIds: string[];
},
ValueTypes['PriceListFixedPricesDeletePayload']
];
priceListUpdate?: [
{
/** The id for the price list. */
id: string /** Provides the input fields required to update a price list. */;
input: ValueTypes['PriceListUpdateInput'];
},
ValueTypes['PriceListUpdatePayload']
];
priceRuleActivate?: [
{
/** ID of the price rule to update. */
id: string;
},
ValueTypes['PriceRuleActivatePayload']
];
priceRuleCreate?: [
{
/** Input fields to create a price rule. */
priceRule: ValueTypes['PriceRuleInput'] /** Input fields to create a discount code for the price rule. */;
priceRuleDiscountCode?: ValueTypes['PriceRuleDiscountCodeInput'] | null;
},
ValueTypes['PriceRuleCreatePayload']
];
priceRuleDeactivate?: [
{
/** ID of the price rule to update. */
id: string;
},
ValueTypes['PriceRuleDeactivatePayload']
];
priceRuleDelete?: [
{
/** The id of the price rule object. */
id: string;
},
ValueTypes['PriceRuleDeletePayload']
];
priceRuleDiscountCodeCreate?: [
{
/** The ID of the price rule object. */
priceRuleId: string /** The code to create for the price rule. */;
code: string;
},
ValueTypes['PriceRuleDiscountCodeCreatePayload']
];
priceRuleDiscountCodeUpdate?: [
{
/** The ID of the price rule object. */
priceRuleId: string /** The new code of a price rule. */;
code: string;
},
ValueTypes['PriceRuleDiscountCodeUpdatePayload']
];
priceRuleUpdate?: [
{
/** ID of the price rule to update. */
id: string /** Input fields to update a price rule. */;
priceRule: ValueTypes['PriceRuleInput'] /** Input fields to update the discount code of the price rule. */;
priceRuleDiscountCode?: ValueTypes['PriceRuleDiscountCodeInput'] | null;
},
ValueTypes['PriceRuleUpdatePayload']
];
privateMetafieldDelete?: [
{
/** The input fields for the private metafield to delete. */
input: ValueTypes['PrivateMetafieldDeleteInput'];
},
ValueTypes['PrivateMetafieldDeletePayload']
];
privateMetafieldUpsert?: [
{
/** Specifies the input fields for the private metafield. */
input: ValueTypes['PrivateMetafieldInput'];
},
ValueTypes['PrivateMetafieldUpsertPayload']
];
productAppendImages?: [
{
/** Specifies the new images and the product that they're being added to. */
input: ValueTypes['ProductAppendImagesInput'];
},
ValueTypes['ProductAppendImagesPayload']
];
productChangeStatus?: [
{
/** The ID of the product. */
productId: string /** The status to be assigned to the product. */;
status: ValueTypes['ProductStatus'];
},
ValueTypes['ProductChangeStatusPayload']
];
productCreate?: [
{
/** The properties of the new product. */
input: ValueTypes['ProductInput'] /** List of new media to be added to the product. */;
media?: ValueTypes['CreateMediaInput'][];
},
ValueTypes['ProductCreatePayload']
];
productCreateMedia?: [
{
/** Specifies the product associated to the media. */
productId: string /** List of new media to be added to a product. */;
media: ValueTypes['CreateMediaInput'][];
},
ValueTypes['ProductCreateMediaPayload']
];
productDelete?: [
{
/** Specifies the product to delete by its ID. */
input: ValueTypes['ProductDeleteInput'];
},
ValueTypes['ProductDeletePayload']
];
productDeleteImages?: [
{
/** This is the ID of the product. */
id: string /** This is the array of image IDs to delete from the product. */;
imageIds: string[];
},
ValueTypes['ProductDeleteImagesPayload']
];
productDeleteMedia?: [
{
/** The ID of the product on which to delete media. */
productId: string /** The media IDs to be deleted. */;
mediaIds: string[];
},
ValueTypes['ProductDeleteMediaPayload']
];
productDuplicate?: [
{
/** The ID of the product to be duplicated. */
productId: string /** The new title of the product. */;
newTitle: string /** The new status of the product. If no value is provided the status will be inherited from the original product. */;
newStatus?: ValueTypes['ProductStatus'] | null /** Specifies whether or not to duplicate images. */;
includeImages?: boolean | null;
},
ValueTypes['ProductDuplicatePayload']
];
productImageUpdate?: [
{
/** The ID of the product on which to update the image. */
productId: string /** Image to be updated. */;
image: ValueTypes['ImageInput'];
},
ValueTypes['ProductImageUpdatePayload']
];
productJoinSellingPlanGroups?: [
{
/** The ID of the product. */
id: string /** The IDs of the selling plan groups to add. */;
sellingPlanGroupIds: string[];
},
ValueTypes['ProductJoinSellingPlanGroupsPayload']
];
productLeaveSellingPlanGroups?: [
{
/** The ID of the product. */
id: string /** The IDs of the selling plan groups to add. */;
sellingPlanGroupIds: string[];
},
ValueTypes['ProductLeaveSellingPlanGroupsPayload']
];
productPublish?: [
{
/** Specifies the product to publish and the channels to publish it to. */
input: ValueTypes['ProductPublishInput'];
},
ValueTypes['ProductPublishPayload']
];
productReorderImages?: [
{
/** The ID of the product on which to reorder images. */
id: string /** A list of moves to perform which will be evaluated in order. */;
moves: ValueTypes['MoveInput'][];
},
ValueTypes['ProductReorderImagesPayload']
];
productReorderMedia?: [
{
/** The ID of the product on which to reorder medias. */
id: string /** A list of moves to perform which will be evaluated in order. */;
moves: ValueTypes['MoveInput'][];
},
ValueTypes['ProductReorderMediaPayload']
];
productUnpublish?: [
{
/** Specifies the product to unpublish and the channel to unpublish it from. */
input: ValueTypes['ProductUnpublishInput'];
},
ValueTypes['ProductUnpublishPayload']
];
productUpdate?: [
{
/** The updated properties for a product. */
input: ValueTypes['ProductInput'];
},
ValueTypes['ProductUpdatePayload']
];
productUpdateMedia?: [
{
/** Specifies the product to update media on. */
productId: string /** A list of media updates. */;
media: ValueTypes['UpdateMediaInput'][];
},
ValueTypes['ProductUpdateMediaPayload']
];
productVariantAppendMedia?: [
{
/** Specifies the product associated to the media. */
productId: string /** A list of pairs of variants and media to be attached to the variants. */;
variantMedia: ValueTypes['ProductVariantAppendMediaInput'][];
},
ValueTypes['ProductVariantAppendMediaPayload']
];
productVariantCreate?: [
{
/** The properties for the new product variant. */
input: ValueTypes['ProductVariantInput'];
},
ValueTypes['ProductVariantCreatePayload']
];
productVariantDelete?: [
{
/** ID of the product variant to be deleted. */
id: string;
},
ValueTypes['ProductVariantDeletePayload']
];
productVariantDetachMedia?: [
{
/** Specifies the product to which the variants and media are associated. */
productId: string /** A list of pairs of variants and media to be deleted from the variants. */;
variantMedia: ValueTypes['ProductVariantDetachMediaInput'][];
},
ValueTypes['ProductVariantDetachMediaPayload']
];
productVariantJoinSellingPlanGroups?: [
{
/** The ID of the product variant. */
id: string /** The IDs of the selling plan groups to add. */;
sellingPlanGroupIds: string[];
},
ValueTypes['ProductVariantJoinSellingPlanGroupsPayload']
];
productVariantLeaveSellingPlanGroups?: [
{
/** The ID of the product variant. */
id: string /** The IDs of the selling plan groups to leave. */;
sellingPlanGroupIds: string[];
},
ValueTypes['ProductVariantLeaveSellingPlanGroupsPayload']
];
productVariantUpdate?: [
{
/** The updated properties for the product variant. */
input: ValueTypes['ProductVariantInput'];
},
ValueTypes['ProductVariantUpdatePayload']
];
productVariantsBulkCreate?: [
{
/** An array of product variants to be created. */
variants: ValueTypes['ProductVariantsBulkInput'][] /** The ID of the product on which to create the variants. */;
productId: string;
},
ValueTypes['ProductVariantsBulkCreatePayload']
];
productVariantsBulkDelete?: [
{
/** An array of product variants IDs to delete. */
variantsIds: string[] /** The ID of the product with the variants to update. */;
productId: string;
},
ValueTypes['ProductVariantsBulkDeletePayload']
];
productVariantsBulkReorder?: [
{
/** The product ID of the variants to be reordered. */
productId: string /** An array of variant positions. */;
positions: ValueTypes['ProductVariantPositionInput'][];
},
ValueTypes['ProductVariantsBulkReorderPayload']
];
productVariantsBulkUpdate?: [
{
/** An array of product variants to update. */
variants: ValueTypes['ProductVariantsBulkInput'][] /** The ID of the product associated with the variants to update. */;
productId: string;
},
ValueTypes['ProductVariantsBulkUpdatePayload']
];
pubSubWebhookSubscriptionCreate?: [
{
/** The type of event that triggers the webhook. */
topic: ValueTypes['WebhookSubscriptionTopic'] /** Specifies the input fields for a Google Cloud Pub/Sub webhook subscription. */;
webhookSubscription: ValueTypes['PubSubWebhookSubscriptionInput'];
},
ValueTypes['PubSubWebhookSubscriptionCreatePayload']
];
pubSubWebhookSubscriptionUpdate?: [
{
/** The ID of the webhook subscription to update. */
id: string /** Specifies the input fields for a Google Cloud Pub/Sub webhook subscription. */;
webhookSubscription?: ValueTypes['PubSubWebhookSubscriptionInput'] | null;
},
ValueTypes['PubSubWebhookSubscriptionUpdatePayload']
];
publishablePublish?: [
{
/** The resource to create or update publications for. */
id: string /** Specifies the input fields required to publish a resource. */;
input: ValueTypes['PublicationInput'][];
},
ValueTypes['PublishablePublishPayload']
];
publishablePublishToCurrentChannel?: [
{
/** The resource to create or update publications for. */
id: string;
},
ValueTypes['PublishablePublishToCurrentChannelPayload']
];
publishableUnpublish?: [
{
/** The resource to delete or update publications for. */
id: string /** Specifies the input fields required to unpublish a resource. */;
input: ValueTypes['PublicationInput'][];
},
ValueTypes['PublishableUnpublishPayload']
];
publishableUnpublishToCurrentChannel?: [
{
/** The resource to delete or update publications for. */
id: string;
},
ValueTypes['PublishableUnpublishToCurrentChannelPayload']
];
refundCreate?: [
{
/** The input fields that are used in the mutation for creating a refund. */
input: ValueTypes['RefundInput'];
},
ValueTypes['RefundCreatePayload']
];
savedSearchCreate?: [
{
/** Specifies the input fields for a saved search. */
input: ValueTypes['SavedSearchCreateInput'];
},
ValueTypes['SavedSearchCreatePayload']
];
savedSearchDelete?: [
{
/** Input fields to delete a saved search. */
input: ValueTypes['SavedSearchDeleteInput'];
},
ValueTypes['SavedSearchDeletePayload']
];
savedSearchUpdate?: [
{
/** Input fields to update a saved search. */
input: ValueTypes['SavedSearchUpdateInput'];
},
ValueTypes['SavedSearchUpdatePayload']
];
scriptTagCreate?: [
{
/** The input fields for a script tag. */
input: ValueTypes['ScriptTagInput'];
},
ValueTypes['ScriptTagCreatePayload']
];
scriptTagDelete?: [
{
/** The ID of the script tag to delete. */
id: string;
},
ValueTypes['ScriptTagDeletePayload']
];
scriptTagUpdate?: [
{
/** The ID of the script tag to update. */
id: string /** Specifies the input fields for a script tag. */;
input: ValueTypes['ScriptTagInput'];
},
ValueTypes['ScriptTagUpdatePayload']
];
sellingPlanGroupAddProductVariants?: [
{
/** The ID of the selling plan group. */
id: string /** The IDs of the product variants to add. */;
productVariantIds: string[];
},
ValueTypes['SellingPlanGroupAddProductVariantsPayload']
];
sellingPlanGroupAddProducts?: [
{
/** The ID of the selling plan group. */
id: string /** The IDs of the products to add. */;
productIds: string[];
},
ValueTypes['SellingPlanGroupAddProductsPayload']
];
sellingPlanGroupCreate?: [
{
/** The properties of the new Selling Plan Group. */
input: ValueTypes['SellingPlanGroupInput'] /** The resources this Selling Plan Group should be applied to. */;
resources?: ValueTypes['SellingPlanGroupResourceInput'] | null;
},
ValueTypes['SellingPlanGroupCreatePayload']
];
sellingPlanGroupDelete?: [
{
/** The id of the selling plan group to delete. */
id: string;
},
ValueTypes['SellingPlanGroupDeletePayload']
];
sellingPlanGroupRemoveProductVariants?: [
{
/** The ID of the selling plan group. */
id: string /** The IDs of the product variants to remove. */;
productVariantIds: string[];
},
ValueTypes['SellingPlanGroupRemoveProductVariantsPayload']
];
sellingPlanGroupRemoveProducts?: [
{
/** The ID of the selling plan group. */
id: string /** The IDs of the products to remove. */;
productIds: string[];
},
ValueTypes['SellingPlanGroupRemoveProductsPayload']
];
sellingPlanGroupUpdate?: [
{
/** The Selling Plan Group to update. */
id: string /** The properties of the Selling Plan Group to update. */;
input?: ValueTypes['SellingPlanGroupInput'] | null;
},
ValueTypes['SellingPlanGroupUpdatePayload']
];
shippingPackageDelete?: [
{
/** The ID of the shipping package to remove. */
id: string;
},
ValueTypes['ShippingPackageDeletePayload']
];
shippingPackageMakeDefault?: [
{
/** The ID of the shipping package to set as the default. */
id: string;
},
ValueTypes['ShippingPackageMakeDefaultPayload']
];
shippingPackageUpdate?: [
{
/** The ID of the shipping package to update. */
id: string;
},
ValueTypes['ShippingPackageUpdatePayload']
];
shopLocaleDisable?: [
{
/** ISO code of the locale to delete. */
locale: string;
},
ValueTypes['ShopLocaleDisablePayload']
];
shopLocaleEnable?: [
{
/** ISO code of the locale to enable. */
locale: string;
},
ValueTypes['ShopLocaleEnablePayload']
];
shopLocaleUpdate?: [
{
/** ISO code of the locale to update. */
locale: string /** Specifies the input fields for a shop locale. */;
shopLocale: ValueTypes['ShopLocaleInput'];
},
ValueTypes['ShopLocaleUpdatePayload']
];
shopPolicyUpdate?: [
{
/** The properties to use when updating the shop policy. */
shopPolicy: ValueTypes['ShopPolicyInput'];
},
ValueTypes['ShopPolicyUpdatePayload']
];
stagedUploadTargetGenerate?: [
{
/** The input fields for generating a staged upload. */
input: ValueTypes['StagedUploadTargetGenerateInput'];
},
ValueTypes['StagedUploadTargetGeneratePayload']
];
stagedUploadTargetsGenerate?: [
{
/** The input fields for generating staged uploads. */
input: ValueTypes['StageImageInput'][];
},
ValueTypes['StagedUploadTargetsGeneratePayload']
];
stagedUploadsCreate?: [
{
/** Input for the mutation includes information needed to generate staged upload targets. */
input: ValueTypes['StagedUploadInput'][];
},
ValueTypes['StagedUploadsCreatePayload']
];
standardMetafieldDefinitionEnable?: [
{
/** The ID of the standard metafield definition template to enable. */
id: string /** The resource type that the metafield definition is scoped to. */;
ownerType: ValueTypes['MetafieldOwnerType'] /** Whether to pin the metafield definition. */;
pin: boolean;
},
ValueTypes['StandardMetafieldDefinitionEnablePayload']
];
storefrontAccessTokenCreate?: [
{
/** Provides the input fields for creating a storefront access token. */
input: ValueTypes['StorefrontAccessTokenInput'];
},
ValueTypes['StorefrontAccessTokenCreatePayload']
];
storefrontAccessTokenDelete?: [
{
/** Provides the input fields required to delete a storefront access token. */
input: ValueTypes['StorefrontAccessTokenDeleteInput'];
},
ValueTypes['StorefrontAccessTokenDeletePayload']
];
subscriptionBillingAttemptCreate?: [
{
/** The ID of the subscription contract. */
subscriptionContractId: string /** The information to apply as a billing attempt. */;
subscriptionBillingAttemptInput: ValueTypes['SubscriptionBillingAttemptInput'];
},
ValueTypes['SubscriptionBillingAttemptCreatePayload']
];
subscriptionContractCreate?: [
{
/** The properties of the new Subscription Contract. */
input: ValueTypes['SubscriptionContractCreateInput'];
},
ValueTypes['SubscriptionContractCreatePayload']
];
subscriptionContractSetNextBillingDate?: [
{
/** The gid of the Subscription Contract to set the next billing date for. */
contractId: string /** The next billing date. */;
date: ValueTypes['DateTime'];
},
ValueTypes['SubscriptionContractSetNextBillingDatePayload']
];
subscriptionContractUpdate?: [
{
/** The gid of the Subscription Contract to update. */
contractId: string;
},
ValueTypes['SubscriptionContractUpdatePayload']
];
subscriptionDraftCommit?: [
{
/** The gid of the Subscription Contract draft to commit. */
draftId: string;
},
ValueTypes['SubscriptionDraftCommitPayload']
];
subscriptionDraftDiscountAdd?: [
{
/** The ID of the Subscription Contract draft to add a subscription discount to. */
draftId: string /** The properties of the new Subscription Discount. */;
input: ValueTypes['SubscriptionManualDiscountInput'];
},
ValueTypes['SubscriptionDraftDiscountAddPayload']
];
subscriptionDraftDiscountCodeApply?: [
{
/** The gid of the subscription contract draft to apply a subscription code discount on. */
draftId: string /** Code discount redeem code. */;
redeemCode: string;
},
ValueTypes['SubscriptionDraftDiscountCodeApplyPayload']
];
subscriptionDraftDiscountRemove?: [
{
/** The gid of the subscription contract draft to remove a subscription discount from. */
draftId: string /** The gid of the subscription draft discount to remove. */;
discountId: string;
},
ValueTypes['SubscriptionDraftDiscountRemovePayload']
];
subscriptionDraftDiscountUpdate?: [
{
/** The ID of the Subscription Contract draft to update a subscription discount on. */
draftId: string /** The gid of the Subscription Discount to update. */;
discountId: string /** The properties to update on the Subscription Discount. */;
input: ValueTypes['SubscriptionManualDiscountInput'];
},
ValueTypes['SubscriptionDraftDiscountUpdatePayload']
];
subscriptionDraftFreeShippingDiscountAdd?: [
{
/** The ID of the subscription contract draft to add a subscription free shipping discount to. */
draftId: string /** The properties of the new subscription free shipping discount. */;
input: ValueTypes['SubscriptionFreeShippingDiscountInput'];
},
ValueTypes['SubscriptionDraftFreeShippingDiscountAddPayload']
];
subscriptionDraftFreeShippingDiscountUpdate?: [
{
/** The ID of the Subscription Contract draft to update a subscription discount on. */
draftId: string /** The gid of the Subscription Discount to update. */;
discountId: string /** The properties to update on the Subscription Free Shipping Discount. */;
input: ValueTypes['SubscriptionFreeShippingDiscountInput'];
},
ValueTypes['SubscriptionDraftFreeShippingDiscountUpdatePayload']
];
subscriptionDraftLineAdd?: [
{
/** The gid of the Subscription Contract draft to add a subscription line to. */
draftId: string /** The properties of the new Subscription Line. */;
input: ValueTypes['SubscriptionLineInput'];
},
ValueTypes['SubscriptionDraftLineAddPayload']
];
subscriptionDraftLineRemove?: [
{
/** The gid of the Subscription Contract draft to remove a subscription line from. */
draftId: string /** The gid of the Subscription Line to remove. */;
lineId: string;
},
ValueTypes['SubscriptionDraftLineRemovePayload']
];
subscriptionDraftLineUpdate?: [
{
/** The gid of the Subscription Contract draft to update a subscription line from. */
draftId: string /** The gid of the Subscription Line to update. */;
lineId: string /** The properties of the new Subscription Line. */;
input: ValueTypes['SubscriptionLineUpdateInput'];
},
ValueTypes['SubscriptionDraftLineUpdatePayload']
];
subscriptionDraftUpdate?: [
{
/** The gid of the Subscription Draft to update. */
draftId: string /** The properties of the new Subscription Contract. */;
input: ValueTypes['SubscriptionDraftInput'];
},
ValueTypes['SubscriptionDraftUpdatePayload']
];
tagsAdd?: [
{
/** The ID of a resource to add tags to. */
id: string /** A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values: `["tag1", "tag2", "tag3"]`, `"tag1, tag2, tag3"`. */;
tags: string[];
},
ValueTypes['TagsAddPayload']
];
tagsRemove?: [
{
/** The ID of the resource to remove tags from. */
id: string /** A list of tags to remove from the resource in the form of an array of strings. Example value: `["tag1", "tag2", "tag3"]`. */;
tags: string[];
},
ValueTypes['TagsRemovePayload']
];
translationsRegister?: [
{
/** ID of the resource that is being translated. */
resourceId: string /** Specifies the input fields for a translation. */;
translations: ValueTypes['TranslationInput'][];
},
ValueTypes['TranslationsRegisterPayload']
];
translationsRemove?: [
{
/** ID of the translatable resource for which translations are being deleted. */
resourceId: string /** List of translation keys. */;
translationKeys: string[] /** List of translation locales. */;
locales: string[];
},
ValueTypes['TranslationsRemovePayload']
];
/** Asynchronously delete [URL redirects](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) in bulk. */
urlRedirectBulkDeleteAll?: ValueTypes['UrlRedirectBulkDeleteAllPayload'];
urlRedirectBulkDeleteByIds?: [
{
/** A list of [`URLRedirect`](
https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect
) object IDs to delete. */
ids: string[];
},
ValueTypes['UrlRedirectBulkDeleteByIdsPayload']
];
urlRedirectBulkDeleteBySavedSearch?: [
{
/** The ID of the URL redirect saved search for filtering. */
savedSearchId: string;
},
ValueTypes['UrlRedirectBulkDeleteBySavedSearchPayload']
];
urlRedirectBulkDeleteBySearch?: [
{
/** Search query for filtering redirects on (both Redirect from and Redirect to fields). */
search: string;
},
ValueTypes['UrlRedirectBulkDeleteBySearchPayload']
];
urlRedirectCreate?: [
{
/** The fields to use when creating the redirect. */
urlRedirect: ValueTypes['UrlRedirectInput'];
},
ValueTypes['UrlRedirectCreatePayload']
];
urlRedirectDelete?: [
{
/** The ID of the redirect to delete. */
id: string;
},
ValueTypes['UrlRedirectDeletePayload']
];
urlRedirectImportCreate?: [
{
/** The S3 URL of the CSV file.
You can download [a sample URL redirect CSV file](https://help.shopify.com/csv/sample-redirect-template.csv)). */
url: ValueTypes['URL'];
},
ValueTypes['UrlRedirectImportCreatePayload']
];
urlRedirectImportSubmit?: [
{
/** The ID of the [`UrlRedirectImport`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object. */
id: string;
},
ValueTypes['UrlRedirectImportSubmitPayload']
];
urlRedirectUpdate?: [
{
/** The ID of the URL redirect to update. */
id: string /** The input fields required to update the URL redirect. */;
urlRedirect: ValueTypes['UrlRedirectInput'];
},
ValueTypes['UrlRedirectUpdatePayload']
];
webhookSubscriptionCreate?: [
{
/** The type of event that triggers the webhook. */
topic: ValueTypes['WebhookSubscriptionTopic'] /** Specifies the input fields for a webhook subscription. */;
webhookSubscription: ValueTypes['WebhookSubscriptionInput'];
},
ValueTypes['WebhookSubscriptionCreatePayload']
];
webhookSubscriptionDelete?: [
{
/** The ID of the webhook subscription to delete. */
id: string;
},
ValueTypes['WebhookSubscriptionDeletePayload']
];
webhookSubscriptionUpdate?: [
{
/** The ID of the webhook subscription to update. */
id: string /** Specifies the input fields for a webhook subscription. */;
webhookSubscription: ValueTypes['WebhookSubscriptionInput'];
},
ValueTypes['WebhookSubscriptionUpdatePayload']
];
__typename?: boolean;
}>;
/** A signed upload parameter for uploading an asset to Shopify. */
['MutationsStagedUploadTargetGenerateUploadParameter']: AliasType<{
/** The upload parameter name. */
name?: boolean;
/** The upload parameter value. */
value?: boolean;
__typename?: boolean;
}>;
/** A default cursor that you can use in queries to paginate your results. Each edge in a connection can
return a cursor, which is a reference to the edge's position in the connection. You can use an edge's cursor as
the starting point to retrieve the nodes before or after it in a connection.
To learn more about using cursor-based pagination, refer to
[Paginating results with GraphQL](https://shopify.dev/api/usage/pagination-graphql). */
['Navigable']: AliasType<{
/** A default cursor that returns the single next record, sorted ascending by ID. */
defaultCursor?: boolean;
['...on OnlineStoreArticle']?: Omit<ValueTypes['OnlineStoreArticle'], keyof ValueTypes['Navigable']>;
['...on OnlineStorePage']?: Omit<ValueTypes['OnlineStorePage'], keyof ValueTypes['Navigable']>;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['Navigable']>;
['...on ProductVariant']?: Omit<ValueTypes['ProductVariant'], keyof ValueTypes['Navigable']>;
__typename?: boolean;
}>;
/** A navigation item, holding basic link attributes. */
['NavigationItem']: AliasType<{
/** The unique identifier of the navigation item. */
id?: boolean;
/** The name of the navigation item. */
title?: boolean;
/** The URL of the page that the navigation item links to. */
url?: boolean;
__typename?: boolean;
}>;
/** 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. */
['Node']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
['...on App']?: Omit<ValueTypes['App'], keyof ValueTypes['Node']>;
['...on AppCredit']?: Omit<ValueTypes['AppCredit'], keyof ValueTypes['Node']>;
['...on AppInstallation']?: Omit<ValueTypes['AppInstallation'], keyof ValueTypes['Node']>;
['...on AppPurchaseOneTime']?: Omit<ValueTypes['AppPurchaseOneTime'], keyof ValueTypes['Node']>;
['...on AppRevenueAttributionRecord']?: Omit<ValueTypes['AppRevenueAttributionRecord'], keyof ValueTypes['Node']>;
['...on AppSubscription']?: Omit<ValueTypes['AppSubscription'], keyof ValueTypes['Node']>;
['...on AppUsageRecord']?: Omit<ValueTypes['AppUsageRecord'], keyof ValueTypes['Node']>;
['...on BasicEvent']?: Omit<ValueTypes['BasicEvent'], keyof ValueTypes['Node']>;
['...on BulkOperation']?: Omit<ValueTypes['BulkOperation'], keyof ValueTypes['Node']>;
['...on CalculatedOrder']?: Omit<ValueTypes['CalculatedOrder'], keyof ValueTypes['Node']>;
['...on Channel']?: Omit<ValueTypes['Channel'], keyof ValueTypes['Node']>;
['...on Collection']?: Omit<ValueTypes['Collection'], keyof ValueTypes['Node']>;
['...on CommentEvent']?: Omit<ValueTypes['CommentEvent'], keyof ValueTypes['Node']>;
['...on Customer']?: Omit<ValueTypes['Customer'], keyof ValueTypes['Node']>;
['...on CustomerPaymentMethod']?: Omit<ValueTypes['CustomerPaymentMethod'], keyof ValueTypes['Node']>;
['...on CustomerVisit']?: Omit<ValueTypes['CustomerVisit'], keyof ValueTypes['Node']>;
['...on DeliveryCarrierService']?: Omit<ValueTypes['DeliveryCarrierService'], keyof ValueTypes['Node']>;
['...on DeliveryCondition']?: Omit<ValueTypes['DeliveryCondition'], keyof ValueTypes['Node']>;
['...on DeliveryCountry']?: Omit<ValueTypes['DeliveryCountry'], keyof ValueTypes['Node']>;
['...on DeliveryLocationGroup']?: Omit<ValueTypes['DeliveryLocationGroup'], keyof ValueTypes['Node']>;
['...on DeliveryMethod']?: Omit<ValueTypes['DeliveryMethod'], keyof ValueTypes['Node']>;
['...on DeliveryMethodDefinition']?: Omit<ValueTypes['DeliveryMethodDefinition'], keyof ValueTypes['Node']>;
['...on DeliveryParticipant']?: Omit<ValueTypes['DeliveryParticipant'], keyof ValueTypes['Node']>;
['...on DeliveryProfile']?: Omit<ValueTypes['DeliveryProfile'], keyof ValueTypes['Node']>;
['...on DeliveryProfileItem']?: Omit<ValueTypes['DeliveryProfileItem'], keyof ValueTypes['Node']>;
['...on DeliveryProvince']?: Omit<ValueTypes['DeliveryProvince'], keyof ValueTypes['Node']>;
['...on DeliveryRateDefinition']?: Omit<ValueTypes['DeliveryRateDefinition'], keyof ValueTypes['Node']>;
['...on DeliveryZone']?: Omit<ValueTypes['DeliveryZone'], keyof ValueTypes['Node']>;
['...on DiscountAutomaticBxgy']?: Omit<ValueTypes['DiscountAutomaticBxgy'], keyof ValueTypes['Node']>;
['...on DiscountAutomaticNode']?: Omit<ValueTypes['DiscountAutomaticNode'], keyof ValueTypes['Node']>;
['...on DiscountCodeNode']?: Omit<ValueTypes['DiscountCodeNode'], keyof ValueTypes['Node']>;
['...on DiscountRedeemCodeBulkCreation']?: Omit<ValueTypes['DiscountRedeemCodeBulkCreation'], keyof ValueTypes['Node']>;
['...on Domain']?: Omit<ValueTypes['Domain'], keyof ValueTypes['Node']>;
['...on DraftOrder']?: Omit<ValueTypes['DraftOrder'], keyof ValueTypes['Node']>;
['...on DraftOrderLineItem']?: Omit<ValueTypes['DraftOrderLineItem'], keyof ValueTypes['Node']>;
['...on Duty']?: Omit<ValueTypes['Duty'], keyof ValueTypes['Node']>;
['...on ExternalVideo']?: Omit<ValueTypes['ExternalVideo'], keyof ValueTypes['Node']>;
['...on Fulfillment']?: Omit<ValueTypes['Fulfillment'], keyof ValueTypes['Node']>;
['...on FulfillmentEvent']?: Omit<ValueTypes['FulfillmentEvent'], keyof ValueTypes['Node']>;
['...on FulfillmentLineItem']?: Omit<ValueTypes['FulfillmentLineItem'], keyof ValueTypes['Node']>;
['...on FulfillmentOrder']?: Omit<ValueTypes['FulfillmentOrder'], keyof ValueTypes['Node']>;
['...on FulfillmentOrderDestination']?: Omit<ValueTypes['FulfillmentOrderDestination'], keyof ValueTypes['Node']>;
['...on FulfillmentOrderLineItem']?: Omit<ValueTypes['FulfillmentOrderLineItem'], keyof ValueTypes['Node']>;
['...on FulfillmentOrderMerchantRequest']?: Omit<ValueTypes['FulfillmentOrderMerchantRequest'], keyof ValueTypes['Node']>;
['...on GenericFile']?: Omit<ValueTypes['GenericFile'], keyof ValueTypes['Node']>;
['...on GiftCard']?: Omit<ValueTypes['GiftCard'], keyof ValueTypes['Node']>;
['...on InventoryItem']?: Omit<ValueTypes['InventoryItem'], keyof ValueTypes['Node']>;
['...on InventoryLevel']?: Omit<ValueTypes['InventoryLevel'], keyof ValueTypes['Node']>;
['...on LineItem']?: Omit<ValueTypes['LineItem'], keyof ValueTypes['Node']>;
['...on LineItemMutable']?: Omit<ValueTypes['LineItemMutable'], keyof ValueTypes['Node']>;
['...on Location']?: Omit<ValueTypes['Location'], keyof ValueTypes['Node']>;
['...on MailingAddress']?: Omit<ValueTypes['MailingAddress'], keyof ValueTypes['Node']>;
['...on MarketingActivity']?: Omit<ValueTypes['MarketingActivity'], keyof ValueTypes['Node']>;
['...on MarketingEvent']?: Omit<ValueTypes['MarketingEvent'], keyof ValueTypes['Node']>;
['...on MediaImage']?: Omit<ValueTypes['MediaImage'], keyof ValueTypes['Node']>;
['...on Metafield']?: Omit<ValueTypes['Metafield'], keyof ValueTypes['Node']>;
['...on MetafieldDefinition']?: Omit<ValueTypes['MetafieldDefinition'], keyof ValueTypes['Node']>;
['...on MetafieldStorefrontVisibility']?: Omit<ValueTypes['MetafieldStorefrontVisibility'], keyof ValueTypes['Node']>;
['...on Model3d']?: Omit<ValueTypes['Model3d'], keyof ValueTypes['Node']>;
['...on OnlineStoreArticle']?: Omit<ValueTypes['OnlineStoreArticle'], keyof ValueTypes['Node']>;
['...on OnlineStoreBlog']?: Omit<ValueTypes['OnlineStoreBlog'], keyof ValueTypes['Node']>;
['...on OnlineStorePage']?: Omit<ValueTypes['OnlineStorePage'], keyof ValueTypes['Node']>;
['...on Order']?: Omit<ValueTypes['Order'], keyof ValueTypes['Node']>;
['...on OrderDisputeSummary']?: Omit<ValueTypes['OrderDisputeSummary'], keyof ValueTypes['Node']>;
['...on OrderTransaction']?: Omit<ValueTypes['OrderTransaction'], keyof ValueTypes['Node']>;
['...on PaymentSchedule']?: Omit<ValueTypes['PaymentSchedule'], keyof ValueTypes['Node']>;
['...on PaymentTerms']?: Omit<ValueTypes['PaymentTerms'], keyof ValueTypes['Node']>;
['...on PaymentTermsTemplate']?: Omit<ValueTypes['PaymentTermsTemplate'], keyof ValueTypes['Node']>;
['...on PriceList']?: Omit<ValueTypes['PriceList'], keyof ValueTypes['Node']>;
['...on PriceRule']?: Omit<ValueTypes['PriceRule'], keyof ValueTypes['Node']>;
['...on PriceRuleDiscountCode']?: Omit<ValueTypes['PriceRuleDiscountCode'], keyof ValueTypes['Node']>;
['...on PrivateMetafield']?: Omit<ValueTypes['PrivateMetafield'], keyof ValueTypes['Node']>;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['Node']>;
['...on ProductOption']?: Omit<ValueTypes['ProductOption'], keyof ValueTypes['Node']>;
['...on ProductTaxonomyNode']?: Omit<ValueTypes['ProductTaxonomyNode'], keyof ValueTypes['Node']>;
['...on ProductVariant']?: Omit<ValueTypes['ProductVariant'], keyof ValueTypes['Node']>;
['...on Publication']?: Omit<ValueTypes['Publication'], keyof ValueTypes['Node']>;
['...on Refund']?: Omit<ValueTypes['Refund'], keyof ValueTypes['Node']>;
['...on SavedSearch']?: Omit<ValueTypes['SavedSearch'], keyof ValueTypes['Node']>;
['...on ScriptTag']?: Omit<ValueTypes['ScriptTag'], keyof ValueTypes['Node']>;
['...on SellingPlan']?: Omit<ValueTypes['SellingPlan'], keyof ValueTypes['Node']>;
['...on SellingPlanGroup']?: Omit<ValueTypes['SellingPlanGroup'], keyof ValueTypes['Node']>;
['...on Shop']?: Omit<ValueTypes['Shop'], keyof ValueTypes['Node']>;
['...on ShopPolicy']?: Omit<ValueTypes['ShopPolicy'], keyof ValueTypes['Node']>;
['...on ShopifyPaymentsAccount']?: Omit<ValueTypes['ShopifyPaymentsAccount'], keyof ValueTypes['Node']>;
['...on ShopifyPaymentsBankAccount']?: Omit<ValueTypes['ShopifyPaymentsBankAccount'], keyof ValueTypes['Node']>;
['...on ShopifyPaymentsDispute']?: Omit<ValueTypes['ShopifyPaymentsDispute'], keyof ValueTypes['Node']>;
['...on ShopifyPaymentsPayout']?: Omit<ValueTypes['ShopifyPaymentsPayout'], keyof ValueTypes['Node']>;
['...on ShopifyPaymentsVerification']?: Omit<ValueTypes['ShopifyPaymentsVerification'], keyof ValueTypes['Node']>;
['...on StandardMetafieldDefinitionTemplate']?: Omit<ValueTypes['StandardMetafieldDefinitionTemplate'], keyof ValueTypes['Node']>;
['...on StorefrontAccessToken']?: Omit<ValueTypes['StorefrontAccessToken'], keyof ValueTypes['Node']>;
['...on SubscriptionBillingAttempt']?: Omit<ValueTypes['SubscriptionBillingAttempt'], keyof ValueTypes['Node']>;
['...on SubscriptionContract']?: Omit<ValueTypes['SubscriptionContract'], keyof ValueTypes['Node']>;
['...on SubscriptionDraft']?: Omit<ValueTypes['SubscriptionDraft'], keyof ValueTypes['Node']>;
['...on TenderTransaction']?: Omit<ValueTypes['TenderTransaction'], keyof ValueTypes['Node']>;
['...on TransactionFee']?: Omit<ValueTypes['TransactionFee'], keyof ValueTypes['Node']>;
['...on UrlRedirect']?: Omit<ValueTypes['UrlRedirect'], keyof ValueTypes['Node']>;
['...on UrlRedirectImport']?: Omit<ValueTypes['UrlRedirectImport'], keyof ValueTypes['Node']>;
['...on Video']?: Omit<ValueTypes['Video'], keyof ValueTypes['Node']>;
['...on WebhookSubscription']?: Omit<ValueTypes['WebhookSubscription'], keyof ValueTypes['Node']>;
__typename?: boolean;
}>;
/** An article in the blogging system. You can query articles from
[the REST API](https://shopify.dev/api/admin-rest/latest/resources/article
if you need to access more information about an article. Currently, `OnlineStoreArticle` is
only useful to pass an article `id` to the `tagsAdd` mutation. For more information, refer to
the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. */
['OnlineStoreArticle']: AliasType<{
/** A default cursor that returns the single next record, sorted ascending by ID. */
defaultCursor?: boolean;
/** A globally-unique identifier. */
id?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
__typename?: boolean;
}>;
/** Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant
to be used as a type of magazine or newsletter for the shop, with content that changes over time. */
['OnlineStoreBlog']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
__typename?: boolean;
}>;
/** A custom page on the Online Store. */
['OnlineStorePage']: AliasType<{
/** A default cursor that returns the single next record, sorted ascending by ID. */
defaultCursor?: boolean;
/** A globally-unique identifier. */
id?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
__typename?: boolean;
}>;
/** Online Store preview URL of the object. */
['OnlineStorePreviewable']: AliasType<{
/** The online store preview URL. */
onlineStorePreviewUrl?: boolean;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['OnlineStorePreviewable']>;
__typename?: boolean;
}>;
/** An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the Order object.
Learn more about [editing an existing order with the Admin API](https://shopify.dev/api/examples/order-editing).
Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders,
then you need to [request access to all orders](https://shopify.dev/apps/auth/oauth#orders-permissions). If your app is granted
access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`.
[Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.
**Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. */
['Order']: AliasType<{
agreements?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `happened_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['SalesAgreementConnection']
];
/** A list of messages that appear on the order page in the Shopify admin. */
alerts?: ValueTypes['ResourceAlert'];
/** The application that created the order. */
app?: ValueTypes['OrderApp'];
/** The billing address of the customer. */
billingAddress?: ValueTypes['MailingAddress'];
/** Whether the billing address matches the shipping address. */
billingAddressMatchesShippingAddress?: boolean;
/** Whether the order can be manually marked as paid. */
canMarkAsPaid?: boolean;
/** Whether a customer email exists for the order. */
canNotifyCustomer?: boolean;
/** The reason provided when the order was canceled.
Returns `null` if the order wasn't canceled. */
cancelReason?: boolean;
/** The date and time when the order was canceled.
Returns `null` if the order wasn't canceled. */
cancelledAt?: boolean;
/** Whether payment for the order can be captured. */
capturable?: boolean;
/** The total order-level discount amount, before returns, in shop currency. */
cartDiscountAmount?: boolean;
/** The total order-level discount amount, before returns, in shop and presentment currencies. */
cartDiscountAmountSet?: ValueTypes['MoneyBag'];
/** The channel that created the order. */
channel?: ValueTypes['Channel'];
/** The IP address of the API client that created the order. */
clientIp?: boolean;
/** Whether the order is closed. */
closed?: boolean;
/** The date and time when the order was closed.
Returns `null` if the order is not closed. */
closedAt?: boolean;
/** Whether inventory has been reserved for the order. */
confirmed?: boolean;
/** Date and time when the order was created in Shopify. */
createdAt?: boolean;
/** The shop currency when the order was placed. */
currencyCode?: boolean;
/** The current order-level discount amount after all order updates, in shop and presentment currencies. */
currentCartDiscountAmountSet?: ValueTypes['MoneyBag'];
/** The sum of the quantities for all line items that contribute to the order's current subtotal price. */
currentSubtotalLineItemsQuantity?: boolean;
/** The sum of the prices for all line items after discounts and returns, in shop and presentment currencies.
If `taxesIncluded` is `true`, then the subtotal also includes tax. */
currentSubtotalPriceSet?: ValueTypes['MoneyBag'];
/** A list of all tax lines applied to line items on the order, after returns.
Tax line prices represent the total price for all tax lines with the same `rate` and `title`. */
currentTaxLines?: ValueTypes['TaxLine'];
/** The total amount discounted on the order after returns, in shop and presentment currencies.
This includes both order and line level discounts. */
currentTotalDiscountsSet?: ValueTypes['MoneyBag'];
/** The total amount of duties after returns, in shop and presentment currencies.
Returns `null` if duties aren't applicable. */
currentTotalDutiesSet?: ValueTypes['MoneyBag'];
/** The total price of the order, after returns, in shop and presentment currencies.
This includes taxes and discounts. */
currentTotalPriceSet?: ValueTypes['MoneyBag'];
/** The sum of the prices of all tax lines applied to line items on the order, after returns, in shop and presentment currencies. */
currentTotalTaxSet?: ValueTypes['MoneyBag'];
/** The total weight of the order after returns, in grams. */
currentTotalWeight?: boolean;
/** A list of the custom attributes added to the order. */
customAttributes?: ValueTypes['Attribute'];
/** The customer that placed the order. */
customer?: ValueTypes['Customer'];
/** Whether the customer agreed to receive marketing materials. */
customerAcceptsMarketing?: boolean;
/** The customer's visits and interactions with the online store before placing the order. */
customerJourney?: ValueTypes['CustomerJourney'];
/** The customer's visits and interactions with the online store before placing the order. */
customerJourneySummary?: ValueTypes['CustomerJourneySummary'];
/** A two-letter or three-letter language code, optionally followed by a region modifier. */
customerLocale?: boolean;
discountApplications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['DiscountApplicationConnection']
];
/** The discount code used for the order. */
discountCode?: boolean;
/** The primary address of the customer.
Returns `null` if neither the shipping address nor the billing address was provided. */
displayAddress?: ValueTypes['MailingAddress'];
/** The financial status of the order that can be shown to the merchant.
This field does not capture all the details of an order's financial state. It should only be used for display summary purposes. */
displayFinancialStatus?: boolean;
/** The fulfillment status for the order that can be shown to the merchant.
This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes.
For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. */
displayFulfillmentStatus?: boolean;
/** A list of the disputes associated with the order. */
disputes?: ValueTypes['OrderDisputeSummary'];
/** A list of draft fulfillments that can be created for the order, which includes line items that can be partially fulfilled. */
draftFulfillments?: ValueTypes['DraftFulfillment'];
/** Whether the order has had any edits applied. */
edited?: boolean;
/** The email address associated with the customer. */
email?: boolean;
/** Whether taxes on the order are estimated.
This field returns `false` when taxes on the order are finalized and aren't subject to any changes. */
estimatedTaxes?: boolean;
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
/** Whether there are line items that can be fulfilled.
This field returns `false` when the order has no fulfillable line items.
For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. */
fulfillable?: boolean;
fulfillmentOrders?: [
{
/** Whether fulfillment orders that are hidden from the merchant are included.
For example, fulfillment orders that were closed after being combined or moved are hidden. */
displayable?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `assigned_location_id`
- `status`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['FulfillmentOrderConnection']
];
fulfillments?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['Fulfillment']
];
/** Whether the order has been paid in full. */
fullyPaid?: boolean;
/** Whether the merchant added a timeline comment to the order. */
hasTimelineComment?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The URL of the first page of the online store that the customer visited before they submitted the order. */
landingPageDisplayText?: boolean;
/** The first page of the online store that the customer visited before they submitted the order. */
landingPageUrl?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
lineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['LineItemConnection']
];
lineItemsMutable?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['LineItemMutableConnection']
];
localizationExtensions?: [
{
/** The country codes of the extensions. */
countryCodes?: ValueTypes['CountryCode'][] /** The purpose of the extensions. */;
purposes?: ValueTypes['LocalizationExtensionPurpose'][] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['LocalizationExtensionConnection']
];
/** The fulfillment location that was assigned when the order was created.
Use the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder) object for up-to-date fulfillment location information. */
location?: boolean;
/** Whether the order can be edited by the merchant. For example, canceled orders can’t be edited. */
merchantEditable?: boolean;
/** A list of reasons why the order can't be edited. For example, "Canceled orders can’t be edited". */
merchantEditableErrors?: boolean;
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafieldDefinitions?: [
{
/** Filter metafield definitions by namespace. */
namespace?: string | null /** Filter by the definition's pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
/** The unique identifier for the order that appears on the order page in the Shopify admin and the order status page.
For example, "#1001", "EN1001", or "1001-A".
This value isn't unique across multiple stores. */
name?: boolean;
/** The net payment for the order, based on the total amount received minus the total amount refunded, in shop currency. */
netPayment?: boolean;
/** The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies. */
netPaymentSet?: ValueTypes['MoneyBag'];
nonFulfillableLineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['LineItemConnection']
];
/** The contents of the note associated with the order. */
note?: boolean;
/** The total amount of duties before returns, in shop and presentment currencies.
Returns `null` if duties aren't applicable. */
originalTotalDutiesSet?: ValueTypes['MoneyBag'];
/** The total price of the order at the time of order creation, in shop and presentment currencies. */
originalTotalPriceSet?: ValueTypes['MoneyBag'];
/** The payment collection details for the order. */
paymentCollectionDetails?: ValueTypes['OrderPaymentCollectionDetails'];
/** A list of the names of all payment gateways used for the order.
For example, "Shopify Payments" and "Cash on Delivery (COD)". */
paymentGatewayNames?: boolean;
/** The payment terms associated with the order. */
paymentTerms?: ValueTypes['PaymentTerms'];
/** The phone number associated with the customer. */
phone?: boolean;
/** The fulfillment location that was assigned when the order was created.
Use the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder) object for up to date fulfillment location information. */
physicalLocation?: ValueTypes['Location'];
/** The payment `CurrencyCode` of the customer for the order. */
presentmentCurrencyCode?: boolean;
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
/** The date and time when the order was processed.
This date and time might not match the date and time when the order was created. */
processedAt?: boolean;
/** The publication that the order was created from. */
publication?: ValueTypes['Publication'];
/** The marketing referral code from the link that the customer clicked to visit the store.
Supports the following URL attributes: "ref", "source", or "r".
For example, if the URL is `{shop}.myshopify.com/products/slide?ref=j2tj1tn2`, then this value is `j2tj1tn2`. */
referralCode?: boolean;
/** A web domain or short description of the source that sent the customer to your online store. For example, "shopify.com" or "email". */
referrerDisplayText?: boolean;
/** The URL of the webpage where the customer clicked a link that sent them to your online store. */
referrerUrl?: boolean;
/** The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor. */
refundDiscrepancySet?: ValueTypes['MoneyBag'];
/** Whether the order can be refunded. */
refundable?: boolean;
refunds?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['Refund']
];
/** Whether the order has shipping lines or at least one line item on the order that requires shipping. */
requiresShipping?: boolean;
/** Whether any line item on the order can be restocked. */
restockable?: boolean;
/** The fraud risk level of the order. */
riskLevel?: boolean;
risks?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['OrderRisk']
];
/** The mailing address of the customer. */
shippingAddress?: ValueTypes['MailingAddress'];
/** A summary of all shipping costs on the order. */
shippingLine?: ValueTypes['ShippingLine'];
shippingLines?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ShippingLineConnection']
];
/** The sum of the quantities for all line items that contribute to the order's subtotal price. */
subtotalLineItemsQuantity?: boolean;
/** The sum of the prices for all line items after discounts and before returns, in shop currency.
If `taxesIncluded` is `true`, then the subtotal also includes tax. */
subtotalPrice?: boolean;
/** The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies.
If `taxesIncluded` is `true`, then the subtotal also includes tax. */
subtotalPriceSet?: ValueTypes['MoneyBag'];
suggestedRefund?: [
{
/** The amount to refund for shipping. Overrides the `refundShipping` argument.
Use the `shippingAmountV2` argument for multi-currency orders. */
shippingAmount?: ValueTypes['Money'] | null /** Whether to refund the full shipping amount. */;
refundShipping?: boolean | null /** The line items from the order to include in the refund. */;
refundLineItems?: ValueTypes['RefundLineItemInput'][] /** The duties from the order to include in the refund. */;
refundDuties?: ValueTypes['RefundDutyInput'][] /** Whether the suggested refund should be created from all refundable line items on the order.
If `true`, the `refundLineItems` argument will be ignored. */;
suggestFullRefund?: boolean | null;
},
ValueTypes['SuggestedRefund']
];
/** A comma separated list of tags associated with the order. Updating `tags` overwrites
any existing tags that were previously added to the order. To add new tags without overwriting
existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)
mutation. */
tags?: boolean;
/** A list of all tax lines applied to line items on the order, before returns.
Tax line prices represent the total price for all tax lines with the same `rate` and `title`. */
taxLines?: ValueTypes['TaxLine'];
/** Whether taxes are included in the subtotal price of the order. */
taxesIncluded?: boolean;
/** Whether the order is a test.
Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
A test order cannot be converted into a real order and vice versa. */
test?: boolean;
/** The authorized amount that is uncaptured or undercaptured, in shop currency.
This amount isn't adjusted for returns. */
totalCapturable?: boolean;
/** The authorized amount that is uncaptured or undercaptured, in shop and presentment currencies.
This amount isn't adjusted for returns. */
totalCapturableSet?: ValueTypes['MoneyBag'];
/** The total amount discounted on the order before returns, in shop currency.
This includes both order and line level discounts. */
totalDiscounts?: boolean;
/** The total amount discounted on the order before returns, in shop and presentment currencies.
This includes both order and line level discounts. */
totalDiscountsSet?: ValueTypes['MoneyBag'];
/** The total amount not yet transacted for the order, in shop and presentment currencies.
A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer). */
totalOutstandingSet?: ValueTypes['MoneyBag'];
/** The total price of the order, before returns, in shop currency.
This includes taxes and discounts. */
totalPrice?: boolean;
/** The total price of the order, before returns, in shop and presentment currencies.
This includes taxes and discounts. */
totalPriceSet?: ValueTypes['MoneyBag'];
/** The total amount received from the customer before returns, in shop currency. */
totalReceived?: boolean;
/** The total amount received from the customer before returns, in shop and presentment currencies. */
totalReceivedSet?: ValueTypes['MoneyBag'];
/** The total amount that was refunded, in shop currency. */
totalRefunded?: boolean;
/** The total amount that was refunded, in shop and presentment currencies. */
totalRefundedSet?: ValueTypes['MoneyBag'];
/** The total amount of shipping that was refunded, in shop and presentment currencies. */
totalRefundedShippingSet?: ValueTypes['MoneyBag'];
/** The total shipping amount before discounts and returns, in shop currency. */
totalShippingPrice?: boolean;
/** The total shipping amount before discounts and returns, in shop and presentment currencies. */
totalShippingPriceSet?: ValueTypes['MoneyBag'];
/** The total tax amount before returns, in shop currency. */
totalTax?: boolean;
/** The total tax amount before returns, in shop and presentment currencies. */
totalTaxSet?: ValueTypes['MoneyBag'];
/** The sum of all tip amounts for the order, in shop currency. */
totalTipReceived?: ValueTypes['MoneyV2'];
/** The sum of all tip amounts for the order, in shop and presentment currencies. */
totalTipReceivedSet?: ValueTypes['MoneyBag'];
/** The total weight of the order before returns, in grams. */
totalWeight?: boolean;
transactions?: [
{
/** Truncate the array result to this size. */
first?: number | null /** Filter transactions by whether they are capturable. */;
capturable?: boolean | null /** Filter transactions by whether they can be resolved manually.
For example, fully captured or voided transactions are not manually resolvable. */;
manuallyResolvable?: boolean | null;
},
ValueTypes['OrderTransaction']
];
/** Whether no payments have been made for the order. */
unpaid?: boolean;
/** The date and time when the order was modified last. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** The possible order action types for a
[sales agreement](https://shopify.dev/api/admin-graphql/latest/interfaces/salesagreement). */
['OrderActionType']: OrderActionType;
/** An agreement associated with an order placement. */
['OrderAgreement']: AliasType<{
/** The application that created the agreement. */
app?: ValueTypes['App'];
/** The date and time at which the agreement occured. */
happenedAt?: boolean;
/** The unique identifier for the agreement. */
id?: boolean;
/** The order associated with the agreement. */
order?: ValueTypes['Order'];
/** The reason the agremeent was created. */
reason?: boolean;
sales?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SaleConnection']
];
__typename?: boolean;
}>;
/** The [application](https://shopify.dev/apps) that created the order. */
['OrderApp']: AliasType<{
/** The application icon. */
icon?: ValueTypes['Image'];
/** The name of the application. */
name?: boolean;
__typename?: boolean;
}>;
/** Represents the reason that the order is being canceled. Valid values are: customer, fraud, inventory, declined, other. */
['OrderCancelReason']: OrderCancelReason;
/** Specifies the authorized transaction to capture and the total amount to capture from it. */
['OrderCaptureInput']: {
/** The ID of the order to capture. */
id: string;
/** The ID of the authorized transaction to capture. */
parentTransactionId: string;
/** The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. */
amount: ValueTypes['Money'];
/** The currency (in ISO format) that is used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ. */
currency?: ValueTypes['CurrencyCode'] | null;
};
/** Return type for `orderCapture` mutation. */
['OrderCapturePayload']: AliasType<{
/** The created capture transaction. */
transaction?: ValueTypes['OrderTransaction'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies an open order to close. */
['OrderCloseInput']: {
/** The ID of the order to close. */
id: string;
};
/** Return type for `orderClose` mutation. */
['OrderClosePayload']: AliasType<{
/** The closed order. */
order?: ValueTypes['Order'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Orders. */
['OrderConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['OrderEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Represents the order's current financial status. */
['OrderDisplayFinancialStatus']: OrderDisplayFinancialStatus;
/** Represents the order's aggregated fulfillment status for display purposes. */
['OrderDisplayFulfillmentStatus']: OrderDisplayFulfillmentStatus;
/** A summary of the important details for a dispute on an order. */
['OrderDisputeSummary']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The type that the dispute was initiated as. */
initiatedAs?: boolean;
/** The current status of the dispute. */
status?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type which holds one Order and a cursor during pagination. */
['OrderEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of OrderEdge. */
node?: ValueTypes['Order'];
__typename?: boolean;
}>;
/** Return type for `orderEditAddCustomItem` mutation. */
['OrderEditAddCustomItemPayload']: AliasType<{
/** The custom line item that will be added to the order based on the current edits. */
calculatedLineItem?: ValueTypes['CalculatedLineItem'];
/** An order with the edits applied but not saved. */
calculatedOrder?: ValueTypes['CalculatedOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `orderEditAddLineItemDiscount` mutation. */
['OrderEditAddLineItemDiscountPayload']: AliasType<{
/** The discount applied to a line item during this order edit. */
addedDiscountStagedChange?: ValueTypes['OrderStagedChangeAddLineItemDiscount'];
/** The line item with the edits applied but not saved. */
calculatedLineItem?: ValueTypes['CalculatedLineItem'];
/** An order with the edits applied but not saved. */
calculatedOrder?: ValueTypes['CalculatedOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `orderEditAddVariant` mutation. */
['OrderEditAddVariantPayload']: AliasType<{
/** The [calculated line item](https://shopify.dev/api/admin-graphql/latest/objects/calculatedlineitem)
that's added during this order edit. */
calculatedLineItem?: ValueTypes['CalculatedLineItem'];
/** The [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)
with the edits applied but not saved. */
calculatedOrder?: ValueTypes['CalculatedOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An agreement associated with an edit to the order. */
['OrderEditAgreement']: AliasType<{
/** The application that created the agreement. */
app?: ValueTypes['App'];
/** The date and time at which the agreement occured. */
happenedAt?: boolean;
/** The unique identifier for the agreement. */
id?: boolean;
/** The reason the agremeent was created. */
reason?: boolean;
sales?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SaleConnection']
];
__typename?: boolean;
}>;
/** The input fields used to add a discount during an order edit. */
['OrderEditAppliedDiscountInput']: {
/** The description of the discount. */
description?: string | null;
/** The value of the discount as a fixed amount. */
fixedValue?: ValueTypes['MoneyInput'] | null;
/** The value of the discount as a percentage. */
percentValue?: number | null;
};
/** Return type for `orderEditBegin` mutation. */
['OrderEditBeginPayload']: AliasType<{
/** The order that will be edited. */
calculatedOrder?: ValueTypes['CalculatedOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `orderEditCommit` mutation. */
['OrderEditCommitPayload']: AliasType<{
/** The order with changes applied. */
order?: ValueTypes['Order'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `orderEditRemoveLineItemDiscount` mutation. */
['OrderEditRemoveLineItemDiscountPayload']: AliasType<{
/** The calculated line item after removal of the discount. */
calculatedLineItem?: ValueTypes['CalculatedLineItem'];
/** An order with the edits applied but not saved. */
calculatedOrder?: ValueTypes['CalculatedOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `orderEditSetQuantity` mutation. */
['OrderEditSetQuantityPayload']: AliasType<{
/** The calculated line item with the edits applied but not saved. */
calculatedLineItem?: ValueTypes['CalculatedLineItem'];
/** The calculated order with the edits applied but not saved. */
calculatedOrder?: ValueTypes['CalculatedOrder'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the information to be updated on an order when using the orderUpdate mutation. */
['OrderInput']: {
/** The ID of the order to update. */
id: string;
/** A new customer email address for the order. Overwrites the existing email address. */
email?: string | null;
/** The new contents for the note associated with the order. Overwrites the existing note. */
note?: string | null;
/** A new list of tags for the order. Overwrites the existing tags. */
tags?: string[];
/** The new shipping address for the order. Overwrites the existing shipping address. */
shippingAddress?: ValueTypes['MailingAddressInput'] | null;
/** A new list of custom attributes for the order. Overwrites the existing custom attributes. */
customAttributes?: ValueTypes['AttributeInput'][];
/** A list of new metafields to add to the existing metafields for the order. */
metafields?: ValueTypes['MetafieldInput'][];
/** A list of new [localization extensions](https://shopify.dev/api/admin-graphql/latest/objects/localizationextension) to add to the existing list of localization extensions for the order. */
localizationExtensions?: ValueTypes['LocalizationExtensionInput'][];
};
/** Return type for `orderInvoiceSend` mutation. */
['OrderInvoiceSendPayload']: AliasType<{
/** The order associated with the invoice email. */
order?: ValueTypes['Order'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['OrderInvoiceSendUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `OrderInvoiceSend`. */
['OrderInvoiceSendUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `OrderInvoiceSendUserError`. */
['OrderInvoiceSendUserErrorCode']: OrderInvoiceSendUserErrorCode;
/** Specifies the order to mark as paid. */
['OrderMarkAsPaidInput']: {
/** The ID of the order to mark as paid. */
id: string;
};
/** Return type for `orderMarkAsPaid` mutation. */
['OrderMarkAsPaidPayload']: AliasType<{
/** The order marked as paid. */
order?: ValueTypes['Order'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies a closed order to open. */
['OrderOpenInput']: {
/** The ID of the order to open. */
id: string;
};
/** Return type for `orderOpen` mutation. */
['OrderOpenPayload']: AliasType<{
/** The opened order. */
order?: ValueTypes['Order'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The payment collection details for an order that requires additional payment following an edit to the order. */
['OrderPaymentCollectionDetails']: AliasType<{
/** The URL to use for collecting an additional payment on the order. */
additionalPaymentCollectionUrl?: boolean;
__typename?: boolean;
}>;
/** Represents a fraud check on an order. */
['OrderRisk']: AliasType<{
/** Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order. */
display?: boolean;
/** The likelihood that an order is fraudulent, based on this order risk.
The level can be set by Shopify risk analysis or by an app. */
level?: boolean;
/** The risk message that's shown to the merchant in the Shopify admin. */
message?: boolean;
__typename?: boolean;
}>;
/** The likelihood that an order is fraudulent. */
['OrderRiskLevel']: OrderRiskLevel;
/** The set of valid sort keys for the Order query. */
['OrderSortKeys']: OrderSortKeys;
/** A change that has been applied to an order. */
['OrderStagedChange']: AliasType<{
['...on OrderStagedChangeAddCustomItem']: ValueTypes['OrderStagedChangeAddCustomItem'];
['...on OrderStagedChangeAddLineItemDiscount']: ValueTypes['OrderStagedChangeAddLineItemDiscount'];
['...on OrderStagedChangeAddShippingLine']: ValueTypes['OrderStagedChangeAddShippingLine'];
['...on OrderStagedChangeAddVariant']: ValueTypes['OrderStagedChangeAddVariant'];
['...on OrderStagedChangeDecrementItem']: ValueTypes['OrderStagedChangeDecrementItem'];
['...on OrderStagedChangeIncrementItem']: ValueTypes['OrderStagedChangeIncrementItem'];
__typename?: boolean;
}>;
/** A change to the order representing the addition of a
custom line item. For example, you might want to add gift wrapping service
as a custom line item. */
['OrderStagedChangeAddCustomItem']: AliasType<{
/** The price of an individual item without any discounts applied. This value cannot be negative. */
originalUnitPrice?: ValueTypes['MoneyV2'];
/** The quantity of the custom item to add to the order. This value must be greater than zero. */
quantity?: boolean;
/** The title of the custom item. */
title?: boolean;
__typename?: boolean;
}>;
/** The discount applied to an item that was added during the current order edit. */
['OrderStagedChangeAddLineItemDiscount']: AliasType<{
/** The description of the discount. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The pricing value of the discount. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** A new [shipping line](https://shopify.dev/api/admin-graphql/latest/objects/shippingline)
added as part of an order edit. */
['OrderStagedChangeAddShippingLine']: AliasType<{
/** The phone number at the shipping address. */
phone?: boolean;
/** The shipping line's title that is shown to the buyer. */
presentmentTitle?: boolean;
/** The price that applies to the shipping line. */
price?: ValueTypes['MoneyV2'];
/** The title of the shipping line. */
title?: boolean;
__typename?: boolean;
}>;
/** A change to the order representing the addition of an existing product variant. */
['OrderStagedChangeAddVariant']: AliasType<{
/** The quantity of the product variant that was added. */
quantity?: boolean;
/** The product variant that was added. */
variant?: ValueTypes['ProductVariant'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple OrderStagedChanges. */
['OrderStagedChangeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['OrderStagedChangeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An removal of items from an existing line item on the order. */
['OrderStagedChangeDecrementItem']: AliasType<{
/** The number of items removed. */
delta?: boolean;
/** The original line item. */
lineItem?: ValueTypes['LineItem'];
/** The intention to restock the removed items. */
restock?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type which holds one OrderStagedChange and a cursor during pagination. */
['OrderStagedChangeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of OrderStagedChangeEdge. */
node?: ValueTypes['OrderStagedChange'];
__typename?: boolean;
}>;
/** An addition of items to an existing line item on the order. */
['OrderStagedChangeIncrementItem']: AliasType<{
/** The number of items added. */
delta?: boolean;
/** The original line item. */
lineItem?: ValueTypes['LineItem'];
__typename?: boolean;
}>;
/** A payment transaction in the context of an order. */
['OrderTransaction']: AliasType<{
/** The masked account number associated with the payment method. */
accountNumber?: boolean;
/** The amount of money. */
amount?: boolean;
/** The amount and currency of the transaction in shop and presentment currencies. */
amountSet?: ValueTypes['MoneyBag'];
/** The amount and currency of the transaction. */
amountV2?: ValueTypes['MoneyV2'];
/** Authorization code associated with the transaction. */
authorizationCode?: boolean;
/** The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. */
authorizationExpiresAt?: boolean;
/** Date and time when the transaction was created. */
createdAt?: boolean;
/** A standardized error code, independent of the payment provider. */
errorCode?: boolean;
/** The transaction fees charged on the order transaction. Only present for Shopify Payments transactions. */
fees?: ValueTypes['TransactionFee'];
/** The human-readable payment gateway name used to process the transaction. */
formattedGateway?: boolean;
/** The payment gateway used to process the transaction. */
gateway?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The kind of transaction. */
kind?: boolean;
/** Whether the transaction can be manually captured. */
manuallyCapturable?: boolean;
/** Specifies the available amount to refund on the gateway.
This value is only available for transactions of type `SuggestedRefund`. */
maximumRefundable?: boolean;
/** Specifies the available amount with currency to refund on the gateway.
This value is only available for transactions of type `SuggestedRefund`. */
maximumRefundableV2?: ValueTypes['MoneyV2'];
/** The associated order. */
order?: ValueTypes['Order'];
/** The associated parent transaction, for example the authorization of a capture. */
parentTransaction?: ValueTypes['OrderTransaction'];
paymentIcon?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** The payment method used for the transaction. This value is `null` if the payment method is unknown. */
paymentMethod?: boolean;
/** Date and time when the transaction was processed. */
processedAt?: boolean;
/** The transaction receipt that the payment gateway attaches to the transaction.
The value of this field depends on which payment gateway processed the transaction. */
receipt?: boolean;
/** The settlement currency. */
settlementCurrency?: boolean;
/** The rate used when converting the transaction amount to settlement currency. */
settlementCurrencyRate?: boolean;
/** Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan. */
shopifyPaymentsSet?: ValueTypes['ShopifyPaymentsTransactionSet'];
/** The status of this transaction. */
status?: boolean;
/** Whether the transaction is a test transaction. */
test?: boolean;
/** Specifies the available amount to capture on the gateway.
Only available when an amount is capturable or manually mark as paid. */
totalUnsettled?: boolean;
/** Specifies the available amount with currency to capture on the gateway in shop and presentment currencies.
Only available when an amount is capturable or manually mark as paid. */
totalUnsettledSet?: ValueTypes['MoneyBag'];
/** Specifies the available amount with currency to capture on the gateway.
Only available when an amount is capturable or manually mark as paid. */
totalUnsettledV2?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple OrderTransactions. */
['OrderTransactionConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['OrderTransactionEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one OrderTransaction and a cursor during pagination. */
['OrderTransactionEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of OrderTransactionEdge. */
node?: ValueTypes['OrderTransaction'];
__typename?: boolean;
}>;
/** A standardized error code, independent of the payment provider. */
['OrderTransactionErrorCode']: OrderTransactionErrorCode;
/** Specifies the information needed to create an order transaction. */
['OrderTransactionInput']: {
/** The amount of money for this transaction. */
amount: ValueTypes['Money'];
/** The payment gateway to use for this transaction. */
gateway: string;
/** The kind of transaction. */
kind: ValueTypes['OrderTransactionKind'];
/** The ID of the order associated with the transaction. */
orderId: string;
/** The ID of the optional parent transaction, for example the authorization of a capture. */
parentId?: string | null;
};
/** The different kinds of order transactions. */
['OrderTransactionKind']: OrderTransactionKind;
/** The different states that an `OrderTransaction` can have. */
['OrderTransactionStatus']: OrderTransactionStatus;
/** Return type for `orderUpdate` mutation. */
['OrderUpdatePayload']: AliasType<{
/** The updated order. */
order?: ValueTypes['Order'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Returns information about pagination in a connection, in accordance with the
[Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). */
['PageInfo']: AliasType<{
/** Whether there are more pages to fetch following the current page. */
hasNextPage?: boolean;
/** Whether there are any pages prior to the current page. */
hasPreviousPage?: boolean;
__typename?: boolean;
}>;
/** Some of the payment methods used in Shopify. */
['PaymentMethods']: PaymentMethods;
/** Represents the payment schedule for a single payment defined in the payment terms. */
['PaymentSchedule']: AliasType<{
/** Amount owed for this payment schedule. */
amount?: ValueTypes['MoneyV2'];
/** Date and time when the payment schedule is paid or fulfilled. */
completedAt?: boolean;
/** Date and time when the payment schedule is due. */
dueAt?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Date and time when the invoice is sent. */
issuedAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple PaymentSchedules. */
['PaymentScheduleConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['PaymentScheduleEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one PaymentSchedule and a cursor during pagination. */
['PaymentScheduleEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of PaymentScheduleEdge. */
node?: ValueTypes['PaymentSchedule'];
__typename?: boolean;
}>;
/** The input fields used to create a payment schedule for payment terms. */
['PaymentScheduleInput']: {
/** Specifies the date and time that the payment schedule was issued. This field must be provided for net type payment terms. */
issuedAt?: ValueTypes['DateTime'] | null;
/** Specifies the date and time when the payment schedule is due. This field must be provided for fixed type payment terms. */
dueAt?: ValueTypes['DateTime'] | null;
};
/** Settings related to payments. */
['PaymentSettings']: AliasType<{
/** List of the digital wallets which the shop supports. */
supportedDigitalWallets?: boolean;
__typename?: boolean;
}>;
/** Represents the payment terms for an order or draft order. */
['PaymentTerms']: AliasType<{
/** Duration of payment terms in days based on the payment terms template used to create the payment terms. */
dueInDays?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Whether the payment terms have overdue payment schedules. */
overdue?: boolean;
paymentSchedules?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PaymentScheduleConnection']
];
/** The name of the payment terms template used to create the payment terms. */
paymentTermsName?: boolean;
/** The type of a payment terms template used to create the payment terms. */
paymentTermsType?: boolean;
/** The translated payment terms name. */
translatedName?: boolean;
__typename?: boolean;
}>;
/** The input fields used to create a payment terms. */
['PaymentTermsCreateInput']: {
/** Specifies the payment terms template ID used to generate payment terms. */
paymentTermsTemplateId: string;
/** Specifies the payment schedules for the payment terms. */
paymentSchedules?: ValueTypes['PaymentScheduleInput'][];
};
/** Return type for `paymentTermsCreate` mutation. */
['PaymentTermsCreatePayload']: AliasType<{
/** The created payment terms. */
paymentTerms?: ValueTypes['PaymentTerms'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PaymentTermsCreateUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `PaymentTermsCreate`. */
['PaymentTermsCreateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `PaymentTermsCreateUserError`. */
['PaymentTermsCreateUserErrorCode']: PaymentTermsCreateUserErrorCode;
/** The input fields used to delete the payment terms. */
['PaymentTermsDeleteInput']: {
/** The ID of the payment terms being deleted. */
paymentTermsId: string;
};
/** Return type for `paymentTermsDelete` mutation. */
['PaymentTermsDeletePayload']: AliasType<{
/** The deleted payment terms id. */
deletedId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PaymentTermsDeleteUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `PaymentTermsDelete`. */
['PaymentTermsDeleteUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `PaymentTermsDeleteUserError`. */
['PaymentTermsDeleteUserErrorCode']: PaymentTermsDeleteUserErrorCode;
/** The input fields used to create a payment terms. */
['PaymentTermsInput']: {
/** Specifies the payment terms template ID used to generate payment terms. */
paymentTermsTemplateId?: string | null;
/** Specifies the payment schedules for the payment terms. */
paymentSchedules?: ValueTypes['PaymentScheduleInput'][];
};
/** Represents the payment terms template object. */
['PaymentTermsTemplate']: AliasType<{
/** The description of the payment terms template. */
description?: boolean;
/** The number of days between the issued date and due date if this is the net type of payment terms. */
dueInDays?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The name of the payment terms template. */
name?: boolean;
/** The type of the payment terms template. */
paymentTermsType?: boolean;
/** The translated payment terms template name. */
translatedName?: boolean;
__typename?: boolean;
}>;
/** The type of a payment terms or a payment terms template. */
['PaymentTermsType']: PaymentTermsType;
/** The input fields used to update the payment terms. */
['PaymentTermsUpdateInput']: {
/** The ID of the payment terms being updated. */
paymentTermsId: string;
/** The attributes used to update the payment terms. */
paymentTermsAttributes: ValueTypes['PaymentTermsInput'];
};
/** Return type for `paymentTermsUpdate` mutation. */
['PaymentTermsUpdatePayload']: AliasType<{
/** The updated payment terms. */
paymentTerms?: ValueTypes['PaymentTerms'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PaymentTermsUpdateUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `PaymentTermsUpdate`. */
['PaymentTermsUpdateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `PaymentTermsUpdateUserError`. */
['PaymentTermsUpdateUserErrorCode']: PaymentTermsUpdateUserErrorCode;
/** Represents a valid PayPal Express subscriptions gateway status. */
['PaypalExpressSubscriptionsGatewayStatus']: PaypalExpressSubscriptionsGatewayStatus;
/** Represents a price list, including information about related prices and eligibility rules.
You can use price lists to specify either fixed prices or adjusted relative prices that
override initial product variant prices. Price lists are applied to customers
using context rules, which determine price list eligibility.
For more information on price lists, refer to
[*Support different pricing models using the price list API*](https://shopify.dev/api/examples/product-price-lists#update-an-existing-price-list). */
['PriceList']: AliasType<{
/** A set of facts about the customer, used to determine price list eligibility. */
contextRule?: ValueTypes['PriceListContextRule'];
/** The currency for fixed prices associated with this price list. */
currency?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The unique name of the price list, used as a human-readable identifier. */
name?: boolean;
/** Relative adjustments to other prices. */
parent?: ValueTypes['PriceListParent'];
prices?: [
{
/** The origin of this price, either fixed (defined on the price list)
or relative (calculated using an adjustment via a price list parent configuration). */
originType?: ValueTypes['PriceListPriceOriginType'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PriceListPriceConnection']
];
__typename?: boolean;
}>;
/** Represents the type and value of price list adjustments. */
['PriceListAdjustment']: AliasType<{
/** The type of price adjustment, such as percentage increase or decrease. */
type?: boolean;
/** The value of price adjustment, where positive numbers
reduce the prices and negative numbers increase them. */
value?: boolean;
__typename?: boolean;
}>;
/** Provides the fields and values to use when updating a price list parent adjustment. */
['PriceListAdjustmentInput']: {
/** The value of the price adjustment, where positive numbers reduce
the prices and negative numbers increase them. */
value: number;
/** The type of price adjustment, such as percentage increase or decrease. */
type: ValueTypes['PriceListAdjustmentType'];
};
/** Represents a percentage price adjustment type. */
['PriceListAdjustmentType']: PriceListAdjustmentType;
/** An auto-generated type for paginating through multiple PriceLists. */
['PriceListConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['PriceListEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Represents a set of facts about the customer used to determine price list eligibility. For example, you can specify the country code so that the price list only applies to customers visiting from a specific country. */
['PriceListContext']: {
/** The code for the country that the price list applies to. */
country?: ValueTypes['CountryCode'] | null;
};
/** Represents a set of facts about the customer used to determine price list eligibility. */
['PriceListContextRule']: AliasType<{
/** A list of two letter country codes that determines price list eligibility. */
countries?: boolean;
__typename?: boolean;
}>;
/** The context that the price list applies to. */
['PriceListContextRuleInput']: {
/** The code for the country that the price list applies to. You can only specify one country code.
Use `marketId` as of version 2022-04 instead. */
countries?: ValueTypes['CountryCode'][];
};
/** Provides the fields and values to use when creating a price list. */
['PriceListCreateInput']: {
/** The unique name of the price list, used as a human-readable identifier. */
name: string;
/** Three letter currency code for fixed prices associated with this price list. */
currency: ValueTypes['CurrencyCode'];
/** Relative adjustments to other prices. */
parent: ValueTypes['PriceListParentCreateInput'];
/** A set of facts about the customer used to determine price list eligibility. */
contextRule?: ValueTypes['PriceListContextRuleInput'] | null;
};
/** Return type for `priceListCreate` mutation. */
['PriceListCreatePayload']: AliasType<{
/** The newly created price list. */
priceList?: ValueTypes['PriceList'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PriceListUserError'];
__typename?: boolean;
}>;
/** Return type for `priceListDelete` mutation. */
['PriceListDeletePayload']: AliasType<{
/** The ID of the deleted price list. */
deletedId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PriceListUserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one PriceList and a cursor during pagination. */
['PriceListEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of PriceListEdge. */
node?: ValueTypes['PriceList'];
__typename?: boolean;
}>;
/** Return type for `priceListFixedPricesAdd` mutation. */
['PriceListFixedPricesAddPayload']: AliasType<{
/** The list of fixed prices that were added to or updated in the price list. */
prices?: ValueTypes['PriceListPrice'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PriceListPriceUserError'];
__typename?: boolean;
}>;
/** Return type for `priceListFixedPricesDelete` mutation. */
['PriceListFixedPricesDeletePayload']: AliasType<{
/** A list of product variant IDs whose fixed prices were removed from the price list. */
deletedFixedPriceVariantIds?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PriceListPriceUserError'];
__typename?: boolean;
}>;
/** Represents relative adjustments from one price list to other prices.
You can use a `PriceListParent` to specify an adjusted relative price using a percentage-based
adjustment. Adjusted prices work in conjunction with exchange rules and rounding.
[Adjustment types](https://shopify.dev/api/admin-graphql/latest/enums/pricelistadjustmenttype)
support both percentage increases and decreases. */
['PriceListParent']: AliasType<{
/** A price list adjustment. */
adjustment?: ValueTypes['PriceListAdjustment'];
__typename?: boolean;
}>;
/** Provides the fields and values to use when creating a price list parent adjustment. */
['PriceListParentCreateInput']: {
/** Provides the fields and values to use when updating a price list parent adjustment. */
adjustment: ValueTypes['PriceListAdjustmentInput'];
};
/** Relative adjustments to other prices. */
['PriceListParentUpdateInput']: {
/** Provides the fields and values to use when updating a price list parent adjustment. */
adjustment: ValueTypes['PriceListAdjustmentInput'];
};
/** Represents information about pricing for a product variant
as defined on a price list, such as the price, compare at price, and origin type. You can use a PriceListPrice to specify a fixed price for a specific product variant. */
['PriceListPrice']: AliasType<{
/** The compare-at price of the product variant on this price list. */
compareAtPrice?: ValueTypes['MoneyV2'];
/** The origin of this price, either fixed (defined on the price list)
or relative (calculated using an adjustment via a price list parent configuration). */
originType?: boolean;
/** The price of the product variant on this price list. */
price?: ValueTypes['MoneyV2'];
/** The product variant associated with this price. */
variant?: ValueTypes['ProductVariant'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple PriceListPrices. */
['PriceListPriceConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['PriceListPriceEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one PriceListPrice and a cursor during pagination. */
['PriceListPriceEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of PriceListPriceEdge. */
node?: ValueTypes['PriceListPrice'];
__typename?: boolean;
}>;
/** Provides the fields and values to use when creating or updating a fixed price list price. */
['PriceListPriceInput']: {
/** The product variant ID associated with the price list price. */
variantId: string;
/** The price of the product variant on this price list. */
price: ValueTypes['MoneyInput'];
/** The compare-at price of the product variant on this price list. */
compareAtPrice?: ValueTypes['MoneyInput'] | null;
};
/** Represents the origin of a price, either fixed (defined on the price list)
or relative (calculated using an adjustment via a price list parent configuration). */
['PriceListPriceOriginType']: PriceListPriceOriginType;
/** An error for a failed price list price operation. */
['PriceListPriceUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `PriceListPriceUserError`. */
['PriceListPriceUserErrorCode']: PriceListPriceUserErrorCode;
/** The set of valid sort keys for the PriceList query. */
['PriceListSortKeys']: PriceListSortKeys;
/** Provides the fields and values to use when updating a price list. */
['PriceListUpdateInput']: {
/** The unique name of the price list, used as a human-readable identifier. */
name?: string | null;
/** The three-letter code for fixed prices associated with this price list. */
currency?: ValueTypes['CurrencyCode'] | null;
/** A set of facts about buyer context used to determine price list eligibility. */
contextRule?: ValueTypes['PriceListContextRuleInput'] | null;
/** Relative adjustments to other prices. */
parent?: ValueTypes['PriceListParentUpdateInput'] | null;
};
/** Return type for `priceListUpdate` mutation. */
['PriceListUpdatePayload']: AliasType<{
/** The updated price list. */
priceList?: ValueTypes['PriceList'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PriceListUserError'];
__typename?: boolean;
}>;
/** Error codes for failed contextual pricing operations. */
['PriceListUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `PriceListUserError`. */
['PriceListUserErrorCode']: PriceListUserErrorCode;
/** Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. We recommend using the [Discount types](https://shopify.dev/api/examples/discounts) available in the GraphQL Admin API, which are intended to replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources. */
['PriceRule']: AliasType<{
/** The maximum number of times that the price rule can be allocated onto an order. */
allocationLimit?: boolean;
/** The method by which the price rule's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The application that created the price rule. */
app?: ValueTypes['App'];
/** The date and time when the price rule was created. */
createdAt?: boolean;
/** The customers that can use this price rule. */
customerSelection?: ValueTypes['PriceRuleCustomerSelection'];
discountCodes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DiscountCodeSortKeys'] | null /** Supported filter parameters:
- `times_used`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['PriceRuleDiscountCodeConnection']
];
/** How many discount codes associated with the price rule. */
discountCodesCount?: boolean;
/** The date and time when the price rule ends. For open-ended price rules, use `null`. */
endsAt?: boolean;
/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */
entitlementToPrerequisiteQuantityRatio?: ValueTypes['PriceRuleEntitlementToPrerequisiteQuantityRatio'];
events?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['EventSortKeys'] | null /** Supported filter parameters:
- `comments`
- `created_at`
- `subject_type`
- `verb`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['EventConnection']
];
/** A list of the price rule's features. */
features?: boolean;
/** Indicates whether there are any timeline comments on the price rule. */
hasTimelineComment?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The items to which the price rule applies. */
itemEntitlements?: ValueTypes['PriceRuleItemEntitlements'];
/** The items required for the price rule to be applicable. */
itemPrerequisites?: ValueTypes['PriceRuleLineItemPrerequisites'];
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** Whether the price rule can be applied only once per customer. */
oncePerCustomer?: boolean;
/** The number of the entitled items must fall within this range for the price rule to be applicable. */
prerequisiteQuantityRange?: ValueTypes['PriceRuleQuantityRange'];
/** The shipping cost must fall within this range for the price rule to be applicable. */
prerequisiteShippingPriceRange?: ValueTypes['PriceRuleMoneyRange'];
/** The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. */
prerequisiteSubtotalRange?: ValueTypes['PriceRuleMoneyRange'];
/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */
prerequisiteToEntitlementQuantityRatio?: ValueTypes['PriceRulePrerequisiteToEntitlementQuantityRatio'];
/** URLs that can be used to share the discount. */
shareableUrls?: ValueTypes['PriceRuleShareableUrl'];
/** The shipping lines to which the price rule applies. */
shippingEntitlements?: ValueTypes['PriceRuleShippingLineEntitlements'];
/** The date and time when the price rule starts. */
startsAt?: boolean;
/** The status of the price rule. */
status?: boolean;
/** A detailed summary of the price rule. */
summary?: boolean;
/** The type of lines (line_item or shipping_line) to which the price rule applies. */
target?: boolean;
/** The title of the price rule. */
title?: boolean;
/** The total sales from orders where the price rule was used. */
totalSales?: ValueTypes['MoneyV2'];
/** A list of the price rule's features. */
traits?: boolean;
/** The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. */
usageCount?: boolean;
/** The maximum number of times that the price rule can be used in total. */
usageLimit?: boolean;
/** A time period during which a price rule is applicable. */
validityPeriod?: ValueTypes['PriceRuleValidityPeriod'];
/** The value of the price rule. */
value?: ValueTypes['PriceRuleValue'];
/** The value of the price rule. */
valueV2?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** Return type for `priceRuleActivate` mutation. */
['PriceRuleActivatePayload']: AliasType<{
/** The activated price rule. */
priceRule?: ValueTypes['PriceRule'];
/** The list of errors that occurred from executing the mutation. */
priceRuleUserErrors?: ValueTypes['PriceRuleUserError'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The method by which the price rule's value is allocated to its entitled items. */
['PriceRuleAllocationMethod']: PriceRuleAllocationMethod;
/** An auto-generated type for paginating through multiple PriceRules. */
['PriceRuleConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['PriceRuleEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `priceRuleCreate` mutation. */
['PriceRuleCreatePayload']: AliasType<{
/** The newly created price rule. */
priceRule?: ValueTypes['PriceRule'];
/** The newly created discount code. */
priceRuleDiscountCode?: ValueTypes['PriceRuleDiscountCode'];
/** The list of errors that occurred from executing the mutation. */
priceRuleUserErrors?: ValueTypes['PriceRuleUserError'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** A selection of customers for whom the price rule applies. */
['PriceRuleCustomerSelection']: AliasType<{
customers?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CustomerSortKeys'] | null /** Supported filter parameters:
- `accepts_marketing`
- `country`
- `customer_date`
- `email`
- `last_abandoned_order_date`
- `order_date`
- `orders_count`
- `phone`
- `state`
- `tag`
- `tag_not`
- `total_spent`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['CustomerConnection']
];
/** Whether the price rule applies to all customers. */
forAllCustomers?: boolean;
/** A list of customer saved searches that contain the customers who can use the price rule. */
savedSearches?: ValueTypes['SavedSearch'];
__typename?: boolean;
}>;
/** Specifies the input fields to update a price rule customer selection. */
['PriceRuleCustomerSelectionInput']: {
/** Whether the price rule applies to all customers. */
forAllCustomers?: boolean | null;
/** List of customers to add to the current list of customers to whom the price rule applies. `savedSearchIds` must be empty. */
customerIdsToAdd?: string[];
/** A list of customers to remove from the current list of customers to whom the price rule applies. */
customerIdsToRemove?: string[];
};
/** Return type for `priceRuleDeactivate` mutation. */
['PriceRuleDeactivatePayload']: AliasType<{
/** The deactivated price rule. */
priceRule?: ValueTypes['PriceRule'];
/** The list of errors that occurred from executing the mutation. */
priceRuleUserErrors?: ValueTypes['PriceRuleUserError'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `priceRuleDelete` mutation. */
['PriceRuleDeletePayload']: AliasType<{
/** The id price of the deleted price rule. */
deletedPriceRuleId?: boolean;
/** The list of errors that occurred from executing the mutation. */
priceRuleUserErrors?: ValueTypes['PriceRuleUserError'];
/** The shop of the deleted price rule. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** A discount code of a price rule. */
['PriceRuleDiscountCode']: AliasType<{
/** The application that created the discount code. */
app?: ValueTypes['App'];
/** The code to use the discount. */
code?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. */
usageCount?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple PriceRuleDiscountCodes. */
['PriceRuleDiscountCodeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['PriceRuleDiscountCodeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `priceRuleDiscountCodeCreate` mutation. */
['PriceRuleDiscountCodeCreatePayload']: AliasType<{
/** The updated price rule. */
priceRule?: ValueTypes['PriceRule'];
/** The newly created discount code. */
priceRuleDiscountCode?: ValueTypes['PriceRuleDiscountCode'];
/** The list of errors that occurred from executing the mutation. */
priceRuleUserErrors?: ValueTypes['PriceRuleUserError'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one PriceRuleDiscountCode and a cursor during pagination. */
['PriceRuleDiscountCodeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of PriceRuleDiscountCodeEdge. */
node?: ValueTypes['PriceRuleDiscountCode'];
__typename?: boolean;
}>;
/** Specifies the input fields to manipulate a discount code. */
['PriceRuleDiscountCodeInput']: {
/** The code to use the discount. */
code?: string | null;
};
/** Return type for `priceRuleDiscountCodeUpdate` mutation. */
['PriceRuleDiscountCodeUpdatePayload']: AliasType<{
/** The updated price rule. */
priceRule?: ValueTypes['PriceRule'];
/** The updated discount code. */
priceRuleDiscountCode?: ValueTypes['PriceRuleDiscountCode'];
/** The list of errors that occurred from executing the mutation. */
priceRuleUserErrors?: ValueTypes['PriceRuleUserError'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one PriceRule and a cursor during pagination. */
['PriceRuleEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of PriceRuleEdge. */
node?: ValueTypes['PriceRule'];
__typename?: boolean;
}>;
/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */
['PriceRuleEntitlementToPrerequisiteQuantityRatio']: AliasType<{
/** The quantity of entitlements in the ratio. */
entitlementQuantity?: boolean;
/** The quantity of prerequisites in the ratio. */
prerequisiteQuantity?: boolean;
__typename?: boolean;
}>;
/** Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */
['PriceRuleEntitlementToPrerequisiteQuantityRatioInput']: {
/** The quantity of entitlements in the ratio. */
entitlementQuantity?: number | null;
/** The quantity of prerequisites in the ratio. */
prerequisiteQuantity?: number | null;
};
/** Possible error codes that could be returned by a price rule mutation. */
['PriceRuleErrorCode']: PriceRuleErrorCode;
/** A list of features used by the price rule. */
['PriceRuleFeature']: PriceRuleFeature;
/** The value of a fixed amount price rule. */
['PriceRuleFixedAmountValue']: AliasType<{
/** The monetary value of the price rule. */
amount?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields to manipulate a price rule. */
['PriceRuleInput']: {
/** PriceRuleValidityPeriod for the price rule. */
validityPeriod?: ValueTypes['PriceRuleValidityPeriodInput'] | null;
/** Whether the price rule can be applied only once per customer. */
oncePerCustomer?: boolean | null;
/** The customers that can use this price rule. */
customerSelection?: ValueTypes['PriceRuleCustomerSelectionInput'] | null;
/** The maximum number of times that the price rule can be used in total. */
usageLimit?: number | null;
/** Title of the price rule. */
title?: string | null;
/** The maximum number of times that the price rule can be allocated onto an order. */
allocationLimit?: number | null;
/** The method by which the price rule's value is allocated to its entitled items. */
allocationMethod?: ValueTypes['PriceRuleAllocationMethod'] | null;
/** The value of the price rule. */
value?: ValueTypes['PriceRuleValueInput'] | null;
/** The type of lines (line_item or shipping_line) to which the price rule applies. */
target?: ValueTypes['PriceRuleTarget'] | null;
/** The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. */
prerequisiteSubtotalRange?: ValueTypes['PriceRuleMoneyRangeInput'] | null;
/** The number of the entitled items must fall within this range for the price rule to be applicable. */
prerequisiteQuantityRange?: ValueTypes['PriceRuleQuantityRangeInput'] | null;
/** The shipping cost must fall within this range for the price rule to be applicable. */
prerequisiteShippingPriceRange?: ValueTypes['PriceRuleMoneyRangeInput'] | null;
/** The items to which the price rule applies. */
itemEntitlements?: ValueTypes['PriceRuleItemEntitlementsInput'] | null;
/** The items required for the price rule to be applicable. */
itemPrerequisites?: ValueTypes['PriceRuleItemPrerequisitesInput'] | null;
/** The shipping lines to which the price rule applies. */
shippingEntitlements?: ValueTypes['PriceRuleShippingEntitlementsInput'] | null;
/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. This argument is deprecated: Use `prerequisiteToEntitlementQuantityRatio` instead. */
entitlementToPrerequisiteQuantityRatio?: ValueTypes['PriceRuleEntitlementToPrerequisiteQuantityRatioInput'] | null;
/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */
prerequisiteToEntitlementQuantityRatio?: ValueTypes['PriceRulePrerequisiteToEntitlementQuantityRatioInput'] | null;
};
/** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */
['PriceRuleItemEntitlements']: AliasType<{
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CollectionConnection']
];
productVariants?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductVariantConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductConnection']
];
/** Whether the price rule applies to all line items. */
targetAllLineItems?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields to update a price rule line item entitlement. */
['PriceRuleItemEntitlementsInput']: {
/** Whether the price rule applies to all items. */
targetAllLineItems?: boolean | null;
/** The products to which the price rule applies. */
productIds?: string[];
/** The product variants to which the price rule applies. */
productVariantIds?: string[];
/** The collections to which the price rule applies. */
collectionIds?: string[];
};
/** Specifies the input fields to update a price rule's item prerequisites. */
['PriceRuleItemPrerequisitesInput']: {
/** The products needed for the price rule to be applied. */
productIds?: string[];
/** The product variants needed for the price rule to be applied. */
productVariantIds?: string[];
/** The collections needed for the price rule to be applied. */
collectionIds?: string[];
};
/** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */
['PriceRuleLineItemPrerequisites']: AliasType<{
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CollectionConnection']
];
productVariants?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductVariantConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductConnection']
];
__typename?: boolean;
}>;
/** A money range within which the price rule is applicable. */
['PriceRuleMoneyRange']: AliasType<{
/** The lower bound of the money range. */
greaterThan?: boolean;
/** The lower bound or equal of the money range. */
greaterThanOrEqualTo?: boolean;
/** The upper bound of the money range. */
lessThan?: boolean;
/** The upper bound or equal of the money range. */
lessThanOrEqualTo?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields to update the money range within which the price rule is applicable. */
['PriceRuleMoneyRangeInput']: {
/** The upper bound of the money range. */
lessThan?: ValueTypes['Money'] | null;
/** The upper or equal bound of the money range. */
lessThanOrEqualTo?: ValueTypes['Money'] | null;
/** The lower bound of the money range. */
greaterThan?: ValueTypes['Money'] | null;
/** The lower or equal bound of the money range. */
greaterThanOrEqualTo?: ValueTypes['Money'] | null;
};
/** The value of a percent price rule. */
['PriceRulePercentValue']: AliasType<{
/** The percent value of the price rule. */
percentage?: boolean;
__typename?: boolean;
}>;
/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */
['PriceRulePrerequisiteToEntitlementQuantityRatio']: AliasType<{
/** The quantity of entitlements in the ratio. */
entitlementQuantity?: boolean;
/** The quantity of prerequisites in the ratio. */
prerequisiteQuantity?: boolean;
__typename?: boolean;
}>;
/** Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */
['PriceRulePrerequisiteToEntitlementQuantityRatioInput']: {
/** The quantity of entitlements in the ratio. */
entitlementQuantity?: number | null;
/** The quantity of prerequisites in the ratio. */
prerequisiteQuantity?: number | null;
};
/** A quantity range within which the price rule is applicable. */
['PriceRuleQuantityRange']: AliasType<{
/** The lower bound of the quantity range. */
greaterThan?: boolean;
/** The lower bound or equal of the quantity range. */
greaterThanOrEqualTo?: boolean;
/** The upper bound of the quantity range. */
lessThan?: boolean;
/** The upper bound or equal of the quantity range. */
lessThanOrEqualTo?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields to update the quantity range within which the price rule is applicable. */
['PriceRuleQuantityRangeInput']: {
/** The upper bound of the quantity range. */
lessThan?: number | null;
/** The upper or equal bound of the quantity range. */
lessThanOrEqualTo?: number | null;
/** The lower bound of the quantity range. */
greaterThan?: number | null;
/** The lower or equal bound of the quantity range. */
greaterThanOrEqualTo?: number | null;
};
/** Shareable URL for the discount code associated with the price rule. */
['PriceRuleShareableUrl']: AliasType<{
/** The image URL of the item (product or collection) to which the discount applies. */
targetItemImage?: ValueTypes['Image'];
/** The type of page that's associated with the URL. */
targetType?: boolean;
/** The title of the page that's associated with the URL. */
title?: boolean;
/** The URL for the discount code. */
url?: boolean;
__typename?: boolean;
}>;
/** Page type where shareable URL lands. */
['PriceRuleShareableUrlTargetType']: PriceRuleShareableUrlTargetType;
/** Specifies the input fields to update a price rule shipping entitlement. */
['PriceRuleShippingEntitlementsInput']: {
/** Whether the price rule applies to all shipping lines. */
targetAllShippingLines?: boolean | null;
/** The codes for the countries to which the price rule applies to. */
countryCodes?: ValueTypes['CountryCode'][];
/** Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones. */
includeRestOfWorld?: boolean | null;
};
/** The shipping lines to which the price rule applies to. */
['PriceRuleShippingLineEntitlements']: AliasType<{
/** The codes for the countries to which the price rule applies to. */
countryCodes?: boolean;
/** Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones. */
includeRestOfWorld?: boolean;
/** Whether the price rule applies to all shipping lines. */
targetAllShippingLines?: boolean;
__typename?: boolean;
}>;
/** The set of valid sort keys for the PriceRule query. */
['PriceRuleSortKeys']: PriceRuleSortKeys;
/** The status of the price rule. */
['PriceRuleStatus']: PriceRuleStatus;
/** The type of lines (line_item or shipping_line) to which the price rule applies. */
['PriceRuleTarget']: PriceRuleTarget;
/** A list of features used by the price rule. */
['PriceRuleTrait']: PriceRuleTrait;
/** Return type for `priceRuleUpdate` mutation. */
['PriceRuleUpdatePayload']: AliasType<{
/** The updated price rule. */
priceRule?: ValueTypes['PriceRule'];
/** The updated discount code. */
priceRuleDiscountCode?: ValueTypes['PriceRuleDiscountCode'];
/** The list of errors that occurred from executing the mutation. */
priceRuleUserErrors?: ValueTypes['PriceRuleUserError'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents an error that happens during execution of a price rule mutation. */
['PriceRuleUserError']: AliasType<{
/** Error code to uniquely identify the error. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** A time period during which a price rule is applicable. */
['PriceRuleValidityPeriod']: AliasType<{
/** The time after which the price rule becomes invalid. */
end?: boolean;
/** The time after which the price rule is valid. */
start?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields to update the validity period of a price rule. */
['PriceRuleValidityPeriodInput']: {
/** The time after which the price rule is valid. */
start: ValueTypes['DateTime'];
/** The time after which the price rule becomes invalid. */
end?: ValueTypes['DateTime'] | null;
};
/** The value of the price rule. */
['PriceRuleValue']: AliasType<{
['...on PriceRuleFixedAmountValue']: ValueTypes['PriceRuleFixedAmountValue'];
['...on PriceRulePercentValue']: ValueTypes['PriceRulePercentValue'];
__typename?: boolean;
}>;
/** Specifies the input fields to update a price rule. */
['PriceRuleValueInput']: {
/** The percentage value of the price rule. */
percentageValue?: number | null;
/** The fixed amount value of the price rule. */
fixedAmountValue?: ValueTypes['Money'] | null;
};
/** The value of the percentage pricing object. */
['PricingPercentageValue']: AliasType<{
/** The percentage value of the object. */
percentage?: boolean;
__typename?: boolean;
}>;
/** The value of the pricing object. */
['PricingValue']: AliasType<{
['...on MoneyV2']: ValueTypes['MoneyV2'];
['...on PricingPercentageValue']: ValueTypes['PricingPercentageValue'];
__typename?: boolean;
}>;
/** Private metafields represent custom metadata that is attached to a resource.
Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.
An application can create a maximum of 10 private metafields per shop resource. */
['PrivateMetafield']: AliasType<{
/** The date and time when the private metafield was created. */
createdAt?: boolean;
/** The id of the private metafield. */
id?: boolean;
/** The key name of the private metafield. */
key?: boolean;
/** The namespace of the private metafield. */
namespace?: boolean;
/** The date and time when the private metafield was updated. */
updatedAt?: boolean;
/** The value of a private metafield. */
value?: boolean;
/** Represents the private metafield value type. */
valueType?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple PrivateMetafields. */
['PrivateMetafieldConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['PrivateMetafieldEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** The input fields for the private metafield to delete. */
['PrivateMetafieldDeleteInput']: {
/** The ID of the resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield. */
owner?: string | null;
/** The namespace of the private metafield. */
namespace: string;
/** The key of the private metafield. */
key: string;
};
/** Return type for `privateMetafieldDelete` mutation. */
['PrivateMetafieldDeletePayload']: AliasType<{
/** The ID of private metafield that was deleted. */
deletedPrivateMetafieldId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one PrivateMetafield and a cursor during pagination. */
['PrivateMetafieldEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of PrivateMetafieldEdge. */
node?: ValueTypes['PrivateMetafield'];
__typename?: boolean;
}>;
/** The input fields for a private metafield. */
['PrivateMetafieldInput']: {
/** The resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield. */
owner?: string | null;
/** The namespace of the private metafield. */
namespace: string;
/** The key of the private metafield. */
key: string;
/** The `value` and `valueType` of the private metafield, wrapped in a `ValueInput` object. */
valueInput: ValueTypes['PrivateMetafieldValueInput'];
};
/** Return type for `privateMetafieldUpsert` mutation. */
['PrivateMetafieldUpsertPayload']: AliasType<{
/** The private metafield that was created or updated. */
privateMetafield?: ValueTypes['PrivateMetafield'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The value input contains the value and value type of the private metafield. */
['PrivateMetafieldValueInput']: {
/** The value of a private metafield. */
value: string;
/** Represents the private metafield value type. */
valueType: ValueTypes['PrivateMetafieldValueType'];
};
/** Supported private metafield value types. */
['PrivateMetafieldValueType']: PrivateMetafieldValueType;
/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */
['Product']: AliasType<{
/** The number of publications a resource is published to without feedback errors. */
availablePublicationCount?: boolean;
/** The description of the product, complete with HTML formatting. */
bodyHtml?: boolean;
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CollectionSortKeys'] | null /** Supported filter parameters:
- `collection_type`
- `publishable_status`
- `published_status`
- `title`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['CollectionConnection']
];
contextualPricing?: [
{
/** The context used to generate contextual pricing for the variant. */
context: ValueTypes['ContextualPricingContext'];
},
ValueTypes['ProductContextualPricing']
];
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created. */
createdAt?: boolean;
/** The custom product type specified by the merchant. */
customProductType?: boolean;
/** A default cursor that returns the single next record, sorted ascending by ID. */
defaultCursor?: boolean;
description?: [
{
/** Truncates string after the given length. */
truncateAt?: number | null;
},
boolean
];
/** The description of the product, complete with HTML formatting. */
descriptionHtml?: boolean;
/** Stripped description of the product, single line with HTML tags removed.
Truncated to 60 characters. */
descriptionPlainSummary?: boolean;
/** The featured image for the product. */
featuredImage?: ValueTypes['Image'];
/** The featured media for the product. */
featuredMedia?: ValueTypes['Media'];
/** Information about the product that's provided through resource feedback. */
feedback?: ValueTypes['ResourceFeedback'];
/** The theme template used when viewing the gift card in a store. */
giftCardTemplateSuffix?: boolean;
/** A unique human-friendly string of the product's title. */
handle?: boolean;
/** Whether the product has only a single variant with the default option and value. */
hasOnlyDefaultVariant?: boolean;
/** Whether the product has out of stock variants. */
hasOutOfStockVariants?: boolean;
/** A globally-unique identifier. */
id?: boolean;
images?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductImageSortKeys'] | null;
},
ValueTypes['ImageConnection']
];
inCollection?: [
{
/** The ID of the collection to check. */
id: string;
},
boolean
];
/** Whether the product is a gift card. */
isGiftCard?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
media?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductMediaSortKeys'] | null;
},
ValueTypes['MediaConnection']
];
/** Total count of media belonging to a product. */
mediaCount?: boolean;
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafieldDefinitions?: [
{
/** Filter metafield definitions by namespace. */
namespace?: string | null /** Filter by the definition's pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
/** The online store preview URL. */
onlineStorePreviewUrl?: boolean;
/** The online store URL for the product.
A value of `null` indicates that the product is not published to the Online Store sales channel. */
onlineStoreUrl?: boolean;
options?: [
{
/** Truncate the array result to this size. */
first?: number | null;
},
ValueTypes['ProductOption']
];
/** The price range of the product. */
priceRange?: ValueTypes['ProductPriceRange'];
/** The price range of the product with prices formatted as decimals. */
priceRangeV2?: ValueTypes['ProductPriceRangeV2'];
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
productPublications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductPublicationConnection']
];
/** The product type specified by the merchant. */
productType?: boolean;
publicationCount?: [
{
/** Include only the resource's publications that are published. If false, then return all the resource's publications including future publications. */
onlyPublished?: boolean | null;
},
boolean
];
publications?: [
{
/** Return only the publications that are published. If false, then return all publications. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductPublicationConnection']
];
/** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was published to the Online Store. */
publishedAt?: boolean;
publishedOnChannel?: [
{
/** The ID of the channel to check. */
channelId: string;
},
boolean
];
/** Check to see whether the resource is published to the calling app's channel. */
publishedOnCurrentChannel?: boolean;
/** Check to see whether the resource is published to the calling app's publication. */
publishedOnCurrentPublication?: boolean;
publishedOnPublication?: [
{
/** The ID of the publication to check. */
publicationId: string;
},
boolean
];
/** Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription (`requiresSellingPlan: true`) can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store. */
requiresSellingPlan?: boolean;
/** The resource that is either published or staged to be published to the calling app's publication. Requires the `read_product_listings` scope. */
resourcePublicationOnCurrentPublication?: ValueTypes['ResourcePublicationV2'];
resourcePublications?: [
{
/** Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationConnection']
];
resourcePublicationsV2?: [
{
/** Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationV2Connection']
];
/** Count of selling plan groups associated with the product. */
sellingPlanGroupCount?: boolean;
sellingPlanGroups?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SellingPlanGroupConnection']
];
/** SEO information of the product. */
seo?: ValueTypes['SEO'];
/** The standardized product type in the Shopify product taxonomy. */
standardizedProductType?: ValueTypes['StandardizedProductType'];
/** The product status. This controls visibility across all channels. */
status?: boolean;
/** The Storefront GraphQL API ID of the `Product`.
As of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead. */
storefrontId?: boolean;
/** A comma separated list of tags associated with the product. Updating `tags` overwrites
any existing tags that were previously added to the product. To add new tags without overwriting
existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)
mutation. */
tags?: boolean;
/** The theme template used when viewing the product in a store. */
templateSuffix?: boolean;
/** The title of the product. */
title?: boolean;
/** The quantity of inventory in stock. */
totalInventory?: boolean;
/** The number of variants that are associated with the product. */
totalVariants?: boolean;
/** Whether inventory tracking has been enabled for the product. */
tracksInventory?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
unpublishedChannels?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ChannelConnection']
];
unpublishedPublications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PublicationConnection']
];
/** The date and time when the product was last modified.
A product's `updatedAt` value can change for different reasons. For example, if an order
is placed for a product that has inventory tracking set up, then the inventory adjustment
is counted as an update. */
updatedAt?: boolean;
variants?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductVariantSortKeys'] | null;
},
ValueTypes['ProductVariantConnection']
];
/** The name of the product's vendor. */
vendor?: boolean;
__typename?: boolean;
}>;
/** Specifies product images to append. */
['ProductAppendImagesInput']: {
/** The ID of the product. */
id: string;
/** The images to be appended to the product. */
images: ValueTypes['ImageInput'][];
};
/** Return type for `productAppendImages` mutation. */
['ProductAppendImagesPayload']: AliasType<{
newImages?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** The product object. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productChangeStatus` mutation. */
['ProductChangeStatusPayload']: AliasType<{
/** The product object. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['ProductChangeStatusUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `ProductChangeStatus`. */
['ProductChangeStatusUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `ProductChangeStatusUserError`. */
['ProductChangeStatusUserErrorCode']: ProductChangeStatusUserErrorCode;
/** The set of valid sort keys for the ProductCollection query. */
['ProductCollectionSortKeys']: ProductCollectionSortKeys;
/** An auto-generated type for paginating through multiple Products. */
['ProductConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ProductEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** The pricing of a particular product in a given context. */
['ProductContextualPricing']: AliasType<{
/** The pricing of the variant with the highest price in the given context. */
maxVariantPricing?: ValueTypes['ProductVariantContextualPricing'];
/** The pricing of the variant with the lowest price in the given context. */
minVariantPricing?: ValueTypes['ProductVariantContextualPricing'];
/** The price range of the product with prices formatted as decimals. */
priceRange?: ValueTypes['ProductPriceRangeV2'];
__typename?: boolean;
}>;
/** Return type for `productCreateMedia` mutation. */
['ProductCreateMediaPayload']: AliasType<{
/** The newly created media. */
media?: ValueTypes['Media'];
/** The list of errors that occurred from executing the mutation. */
mediaUserErrors?: ValueTypes['MediaUserError'];
/** The product associated with the media. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productCreate` mutation. */
['ProductCreatePayload']: AliasType<{
/** The product object. */
product?: ValueTypes['Product'];
/** The shop associated with the product. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productDeleteImages` mutation. */
['ProductDeleteImagesPayload']: AliasType<{
/** This is an array of IDs of images to delete. */
deletedImageIds?: boolean;
/** This is the product object. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the product to delete. */
['ProductDeleteInput']: {
/** The ID of the product. */
id: string;
};
/** Return type for `productDeleteMedia` mutation. */
['ProductDeleteMediaPayload']: AliasType<{
/** List of media IDs which were deleted. */
deletedMediaIds?: boolean;
/** List of product image IDs which were deleted. */
deletedProductImageIds?: boolean;
/** The list of errors that occurred from executing the mutation. */
mediaUserErrors?: ValueTypes['MediaUserError'];
/** The product which media was deleted from. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productDelete` mutation. */
['ProductDeletePayload']: AliasType<{
/** The ID of the deleted product. */
deletedProductId?: boolean;
/** The shop associated with the product. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productDuplicate` mutation. */
['ProductDuplicatePayload']: AliasType<{
/** The asynchronous job duplicating the product images. */
imageJob?: ValueTypes['Job'];
/** The duplicated product. */
newProduct?: ValueTypes['Product'];
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Product and a cursor during pagination. */
['ProductEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ProductEdge. */
node?: ValueTypes['Product'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the ProductImage query. */
['ProductImageSortKeys']: ProductImageSortKeys;
/** Return type for `productImageUpdate` mutation. */
['ProductImageUpdatePayload']: AliasType<{
image?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the input fields required to create a product. */
['ProductInput']: {
/** The description of the product, complete with HTML formatting. */
descriptionHtml?: string | null;
/** A unique human-friendly string for the product. Automatically generated from the product's title. */
handle?: string | null;
/** Whether a redirect is required after a new handle has been provided.
If true, then the old handle is redirected to the new one automatically. */
redirectNewHandle?: boolean | null;
/** The SEO information associated with the product. */
seo?: ValueTypes['SEOInput'] | null;
/** The product type specified by the merchant. */
productType?: string | null;
/** The standardized product type in the Shopify product taxonomy. */
standardizedProductType?: ValueTypes['StandardizedProductTypeInput'] | null;
/** The custom product type specified by the merchant. */
customProductType?: string | null;
/** A comma separated list tags that have been added to the product. */
tags?: string[];
/** The theme template used when viewing the product in a store. */
templateSuffix?: string | null;
/** Whether the product is a gift card. */
giftCard?: boolean | null;
/** The theme template used when viewing the gift card in a store. */
giftCardTemplateSuffix?: string | null;
/** The title of the product. */
title?: string | null;
/** The name of the product's vendor. */
vendor?: string | null;
/** A description of the product. Supports HTML formatting. This argument is deprecated: Use `descriptionHtml` instead. */
bodyHtml?: string | null;
/** The IDs of the collections that this product will be added to. */
collectionsToJoin?: string[];
/** The IDs of collections that will no longer include the product. */
collectionsToLeave?: string[];
/** Specifies the product to update in productUpdate or creates a new product if absent in productCreate. */
id?: string | null;
/** The images to associate with the product. */
images?: ValueTypes['ImageInput'][];
/** The metafields to associate with this product. */
metafields?: ValueTypes['MetafieldInput'][];
/** The private metafields to associate with this product. */
privateMetafields?: ValueTypes['PrivateMetafieldInput'][];
/** List of custom product options (maximum of 3 per product). */
options?: string[];
/** A list of the channels where the product is published. This argument is deprecated: Use `PublishablePublish` instead. */
productPublications?: ValueTypes['ProductPublicationInput'][];
/** A list of the channels where the product is published. This argument is deprecated: Use `PublishablePublish` instead. */
publications?: ValueTypes['ProductPublicationInput'][];
/** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */
publishDate?: ValueTypes['DateTime'] | null;
/** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */
publishOn?: ValueTypes['DateTime'] | null;
/** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */
published?: boolean | null;
/** Only products with an active status can be published. This argument is deprecated: Use `PublishablePublish` instead. */
publishedAt?: ValueTypes['DateTime'] | null;
/** A list of variants associated with the product. */
variants?: ValueTypes['ProductVariantInput'][];
/** The status of the product. */
status?: ValueTypes['ProductStatus'] | null;
/** Whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to `true` on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions. */
requiresSellingPlan?: boolean | null;
};
/** Return type for `productJoinSellingPlanGroups` mutation. */
['ProductJoinSellingPlanGroupsPayload']: AliasType<{
/** The product object. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Return type for `productLeaveSellingPlanGroups` mutation. */
['ProductLeaveSellingPlanGroupsPayload']: AliasType<{
/** The product object. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the ProductMedia query. */
['ProductMediaSortKeys']: ProductMediaSortKeys;
/** Product property names like "Size", "Color", and "Material".
Variants are selected based on permutations of these options.
255 characters limit each. */
['ProductOption']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The product option’s name. */
name?: boolean;
/** The product option's position. */
position?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
/** The corresponding value to the product option name. */
values?: boolean;
__typename?: boolean;
}>;
/** The price range of the product. */
['ProductPriceRange']: AliasType<{
/** The highest variant's price. */
maxVariantPrice?: ValueTypes['MoneyV2'];
/** The lowest variant's price. */
minVariantPrice?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** The price range of the product. */
['ProductPriceRangeV2']: AliasType<{
/** The highest variant's price. */
maxVariantPrice?: ValueTypes['MoneyV2'];
/** The lowest variant's price. */
minVariantPrice?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** Represents the channels where a product is published. */
['ProductPublication']: AliasType<{
/** The channel where the product was or is published. */
channel?: ValueTypes['Channel'];
/** Whether the publication is published or not. */
isPublished?: boolean;
/** The product that was or is going to be published on the channel. */
product?: ValueTypes['Product'];
/** The date that the product was or is going to be published on the channel. */
publishDate?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ProductPublications. */
['ProductPublicationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ProductPublicationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ProductPublication and a cursor during pagination. */
['ProductPublicationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ProductPublicationEdge. */
node?: ValueTypes['ProductPublication'];
__typename?: boolean;
}>;
/** Specifies a publication to which a product will be published. */
['ProductPublicationInput']: {
/** ID of the publication. */
publicationId?: string | null;
/** ID of the channel. This argument is deprecated: Use publicationId instead. */
channelId?: string | null;
/** This argument is deprecated: Use publicationId instead. */
channelHandle?: string | null;
/** The date and time that the product was (or will be) published. */
publishDate?: ValueTypes['DateTime'] | null;
};
/** Specifies a product to publish and the channels to publish it to. */
['ProductPublishInput']: {
/** The product to create or update publications for. */
id: string;
/** The publication that the product is published to. */
productPublications: ValueTypes['ProductPublicationInput'][];
};
/** Return type for `productPublish` mutation. */
['ProductPublishPayload']: AliasType<{
/** The product that has been published. */
product?: ValueTypes['Product'];
/** The channels where the product is published. */
productPublications?: ValueTypes['ProductPublication'];
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productReorderImages` mutation. */
['ProductReorderImagesPayload']: AliasType<{
/** The asynchronous job reordering the images. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productReorderMedia` mutation. */
['ProductReorderMediaPayload']: AliasType<{
/** The asynchronous job reordering the media. */
job?: ValueTypes['Job'];
/** The list of errors that occurred from executing the mutation. */
mediaUserErrors?: ValueTypes['MediaUserError'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Reports the status of product for a Sales Channel or Storefront API.
This might include why a product is not available in a Sales Channel
and how a merchant might fix this. */
['ProductResourceFeedback']: AliasType<{
/** The time when the feedback was generated. Used to help determine whether
incoming feedback is outdated compared to existing feedback. */
feedbackGeneratedAt?: boolean;
/** The feedback messages presented to the merchant. */
messages?: boolean;
/** The ID of the product associated with the feedback. */
productId?: boolean;
/** The timestamp of the product associated with the feedback. */
productUpdatedAt?: boolean;
/** Conveys the state of the feedback and whether it requires merchant action or not. */
state?: boolean;
__typename?: boolean;
}>;
/** The input fields used to create a product feedback. */
['ProductResourceFeedbackInput']: {
/** The ID of the product that the feedback was created on. */
productId: string;
/** Whether the merchant needs to take action on the product. */
state: ValueTypes['ResourceFeedbackState'];
/** The date and time when the payload is constructed.
Used to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival. */
feedbackGeneratedAt: ValueTypes['DateTime'];
/** The timestamp of the product associated with the feedback. */
productUpdatedAt: ValueTypes['DateTime'];
/** A concise set of copy strings to be displayed to merchants. Used to guide merchants in resolving problems that your app encounters when trying to make use of their products.
You can specify up to four messages. Each message is limited to 100 characters. */
messages?: string[];
};
/** A sale associated with a product. */
['ProductSale']: AliasType<{
/** The type of order action that the sale represents. */
actionType?: boolean;
/** The unique identifier for the sale. */
id?: boolean;
/** The line item for the associated sale. */
lineItem?: ValueTypes['LineItem'];
/** The line type assocated with the sale. */
lineType?: boolean;
/** The number of units either ordered or intended to be returned. */
quantity?: boolean;
/** All individual taxes associated with the sale. */
taxes?: ValueTypes['SaleTax'];
/** The total sale amount after taxes and discounts. */
totalAmount?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale after taxes. */
totalDiscountAmountAfterTaxes?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale before taxes. */
totalDiscountAmountBeforeTaxes?: ValueTypes['MoneyBag'];
/** The total amount of taxes for the sale. */
totalTaxAmount?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the Product query. */
['ProductSortKeys']: ProductSortKeys;
/** The possible product statuses. */
['ProductStatus']: ProductStatus;
/** Represents a [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) node. */
['ProductTaxonomyNode']: AliasType<{
/** The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds. */
fullName?: boolean;
/** The ID of the product taxonomy node. */
id?: boolean;
/** Whether the node is a leaf node. */
isLeaf?: boolean;
/** Whether the node is a root node. */
isRoot?: boolean;
/** The name of the product taxonomy node. For example, Dog Beds. */
name?: boolean;
__typename?: boolean;
}>;
/** Specifies a product to unpublish from a channel and the sales channels to unpublish it from. */
['ProductUnpublishInput']: {
/** The ID of the product to create or update publications for. */
id: string;
/** The channels to unpublish the product from. */
productPublications: ValueTypes['ProductPublicationInput'][];
};
/** Return type for `productUnpublish` mutation. */
['ProductUnpublishPayload']: AliasType<{
/** The product that has been unpublished. */
product?: ValueTypes['Product'];
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productUpdateMedia` mutation. */
['ProductUpdateMediaPayload']: AliasType<{
/** The updated media. */
media?: ValueTypes['Media'];
/** The list of errors that occurred from executing the mutation. */
mediaUserErrors?: ValueTypes['MediaUserError'];
/** The product which media was updated on. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productUpdate` mutation. */
['ProductUpdatePayload']: AliasType<{
/** The updated product. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents a product variant. */
['ProductVariant']: AliasType<{
/** Whether the product variant is available for sale. */
availableForSale?: boolean;
/** The value of the barcode associated with the product. */
barcode?: boolean;
/** The compare-at price of the variant in the default shop currency. */
compareAtPrice?: boolean;
contextualPricing?: [
{
/** The context used to generate contextual pricing for the variant. */
context: ValueTypes['ContextualPricingContext'];
},
ValueTypes['ProductVariantContextualPricing']
];
/** The date and time when the variant was created. */
createdAt?: boolean;
/** A default cursor that returns the single next record, sorted ascending by ID. */
defaultCursor?: boolean;
/** The delivery profile for the variant. */
deliveryProfile?: ValueTypes['DeliveryProfile'];
/** Display name of the variant, based on product's title + variant's title. */
displayName?: boolean;
/** The fulfillment service associated with the product. */
fulfillmentService?: ValueTypes['FulfillmentService'];
/** Whether changes to the fulfillment service for the product variant are allowed. */
fulfillmentServiceEditable?: ValueTypes['EditableProperty'];
/** The Harmonized System Code (or HS Tariff Code) for the variant. */
harmonizedSystemCode?: boolean;
/** A globally-unique identifier. */
id?: boolean;
image?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null;
},
ValueTypes['Image']
];
/** The inventory item, which is used to query for inventory information. */
inventoryItem?: ValueTypes['InventoryItem'];
/** The fulfillment service that tracks the number of items in stock for the product variant. */
inventoryManagement?: boolean;
/** Whether customers are allowed to place an order for the product variant when it's out of stock. */
inventoryPolicy?: boolean;
/** The total sellable quantity of the variant. */
inventoryQuantity?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
media?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MediaConnection']
];
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafieldDefinitions?: [
{
/** Filter metafield definitions by namespace. */
namespace?: string | null /** Filter by the definition's pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
/** The order of the product variant in the list of product variants. The first position in the list is 1. */
position?: boolean;
presentmentPrices?: [
{
/** The presentment currencies prices should return in. */
presentmentCurrencies?: ValueTypes['CurrencyCode'][] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductVariantPricePairConnection']
];
/** The price of the product variant in the default shop currency. */
price?: boolean;
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
/** The product that this variant belongs to. */
product?: ValueTypes['Product'];
/** Whether a customer needs to provide a shipping address when placing an order for the product variant. */
requiresShipping?: boolean;
/** List of product options applied to the variant. */
selectedOptions?: ValueTypes['SelectedOption'];
/** The total sellable quantity of the variant for online channels.
This doesn't represent the total available inventory or capture
[limitations based on customer location](https://help.shopify.com/manual/markets/inventory_and_fulfillment). */
sellableOnlineQuantity?: boolean;
/** Count of selling plan groups associated with the product variant. */
sellingPlanGroupCount?: boolean;
sellingPlanGroups?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SellingPlanGroupConnection']
];
/** An identifier for the product variant in the shop. Required in order to connect to a fulfillment service. */
sku?: boolean;
/** The Storefront GraphQL API ID of the `ProductVariant`.
As of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead. */
storefrontId?: boolean;
/** The tax code for the product variant. */
taxCode?: boolean;
/** Whether a tax is charged when the product variant is sold. */
taxable?: boolean;
/** The title of the product variant. */
title?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
/** The date and time (ISO 8601 format) when the product variant was last modified. */
updatedAt?: boolean;
/** The weight of the product variant in the unit system specified with weight_unit. */
weight?: boolean;
/** The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: `g`, `kg`, `oz`, `lb`. */
weightUnit?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields required to append media to a single variant. */
['ProductVariantAppendMediaInput']: {
/** Specifies the variant to which media will be appended. */
variantId: string;
/** Specifies the media to append to the variant. */
mediaIds: string[];
};
/** Return type for `productVariantAppendMedia` mutation. */
['ProductVariantAppendMediaPayload']: AliasType<{
/** The product associated with the variants and media. */
product?: ValueTypes['Product'];
/** The product variants that were updated. */
productVariants?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MediaUserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ProductVariants. */
['ProductVariantConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ProductVariantEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** The pricing of a particular product variant in a given context. */
['ProductVariantContextualPricing']: AliasType<{
/** The final compare-at price after all adjustments are applied. */
compareAtPrice?: ValueTypes['MoneyV2'];
/** The final price after all adjustments are applied. */
price?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** Return type for `productVariantCreate` mutation. */
['ProductVariantCreatePayload']: AliasType<{
/** The product associated with the variant. */
product?: ValueTypes['Product'];
/** The successfully created variant. */
productVariant?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productVariantDelete` mutation. */
['ProductVariantDeletePayload']: AliasType<{
/** ID of the deleted product variant. */
deletedProductVariantId?: boolean;
/** Product of the deleted product variant. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the input fields required to detach media from a single variant. */
['ProductVariantDetachMediaInput']: {
/** Specifies the variant from which media will be detached. */
variantId: string;
/** Specifies the media to detach from the variant. */
mediaIds: string[];
};
/** Return type for `productVariantDetachMedia` mutation. */
['ProductVariantDetachMediaPayload']: AliasType<{
/** The product associated with the variants and media. */
product?: ValueTypes['Product'];
/** The product variants that were updated. */
productVariants?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['MediaUserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ProductVariant and a cursor during pagination. */
['ProductVariantEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ProductVariantEdge. */
node?: ValueTypes['ProductVariant'];
__typename?: boolean;
}>;
/** Specifies a product variant to create or update. */
['ProductVariantInput']: {
/** The value of the barcode associated with the product. */
barcode?: string | null;
/** The compare-at price of the variant. */
compareAtPrice?: ValueTypes['Money'] | null;
/** The ID of the fulfillment service associated with the variant. */
fulfillmentServiceId?: string | null;
/** The Harmonized System Code (or HS Tariff Code) for the variant. */
harmonizedSystemCode?: string | null;
/** Specifies the product variant to update or create a new variant if absent. */
id?: string | null;
/** The ID of the image that's associated with the variant. */
imageId?: string | null;
/** The URL of an image to associate with the variant. This field can only be used through mutations that create product images and must match one of the URLs being created on the product. */
imageSrc?: string | null;
/** The URL of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the URLs being created on the product. This field only accepts one value. */
mediaSrc?: string[];
/** The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to `shopify`. Valid values: `shopify` or the handle of a fulfillment service that has inventory management enabled.
This argument is deprecated: Use tracked attribute on `inventoryItem` instead. */
inventoryManagement?: ValueTypes['ProductVariantInventoryManagement'] | null;
/** Whether customers are allowed to place an order for the product variant when it's out of stock. */
inventoryPolicy?: ValueTypes['ProductVariantInventoryPolicy'] | null;
/** Create only field. The inventory quantities at each location where the variant is stocked. */
inventoryQuantities?: ValueTypes['InventoryLevelInput'][];
/** Inventory Item associated with the variant, used for unit cost. */
inventoryItem?: ValueTypes['InventoryItemInput'] | null;
/** Additional customizable information about the product variant. */
metafields?: ValueTypes['MetafieldInput'][];
/** The private metafields to associated with this product. */
privateMetafields?: ValueTypes['PrivateMetafieldInput'][];
/** The custom properties that a shop owner uses to define product variants. */
options?: string[];
/** The order of the product variant in the list of product variants. The first position in the list is 1. */
position?: number | null;
/** The price of the variant. */
price?: ValueTypes['Money'] | null;
/** Create only required field. Specifies the product on which to create the variant. */
productId?: string | null;
/** Whether the variant requires shipping. */
requiresShipping?: boolean | null;
/** The SKU for the variant. */
sku?: string | null;
/** Whether the variant is taxable. */
taxable?: boolean | null;
/** This argument is deprecated: Variant title is not a writable field; it is generated from the selected variant options. */
title?: string | null;
/** The tax code associated with the variant. */
taxCode?: string | null;
/** The weight of the variant. */
weight?: number | null;
/** The unit of weight that's used to measure the variant. */
weightUnit?: ValueTypes['WeightUnit'] | null;
};
/** The valid values for the method of inventory tracking for a product variant. */
['ProductVariantInventoryManagement']: ProductVariantInventoryManagement;
/** The valid values for the inventory policy of a product variant once it is out of stock. */
['ProductVariantInventoryPolicy']: ProductVariantInventoryPolicy;
/** Return type for `productVariantJoinSellingPlanGroups` mutation. */
['ProductVariantJoinSellingPlanGroupsPayload']: AliasType<{
/** The product variant object. */
productVariant?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Return type for `productVariantLeaveSellingPlanGroups` mutation. */
['ProductVariantLeaveSellingPlanGroupsPayload']: AliasType<{
/** The product variant object. */
productVariant?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Represents a product variant position. */
['ProductVariantPositionInput']: {
/** Specifies the ID of the product variant to update. */
id: string;
/** The order of the product variant in the list of product variants. The first position in the list is 1. */
position: number;
};
/** The compare-at price and price of a variant sharing a currency. */
['ProductVariantPricePair']: AliasType<{
/** The compare-at price of the variant with associated currency. */
compareAtPrice?: ValueTypes['MoneyV2'];
/** The price of the variant with associated currency. */
price?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ProductVariantPricePairs. */
['ProductVariantPricePairConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ProductVariantPricePairEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. */
['ProductVariantPricePairEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ProductVariantPricePairEdge. */
node?: ValueTypes['ProductVariantPricePair'];
__typename?: boolean;
}>;
/** The set of valid sort keys for the ProductVariant query. */
['ProductVariantSortKeys']: ProductVariantSortKeys;
/** Return type for `productVariantUpdate` mutation. */
['ProductVariantUpdatePayload']: AliasType<{
/** The product associated with the variant. */
product?: ValueTypes['Product'];
/** The updated variant. */
productVariant?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `productVariantsBulkCreate` mutation. */
['ProductVariantsBulkCreatePayload']: AliasType<{
/** The updated product object. */
product?: ValueTypes['Product'];
/** The newly created variants. */
productVariants?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['ProductVariantsBulkCreateUserError'];
__typename?: boolean;
}>;
/** Error codes for failed product variant bulk create mutations. */
['ProductVariantsBulkCreateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `ProductVariantsBulkCreateUserError`. */
['ProductVariantsBulkCreateUserErrorCode']: ProductVariantsBulkCreateUserErrorCode;
/** Return type for `productVariantsBulkDelete` mutation. */
['ProductVariantsBulkDeletePayload']: AliasType<{
/** The updated product object. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['ProductVariantsBulkDeleteUserError'];
__typename?: boolean;
}>;
/** Error codes for failed bulk variant delete mutations. */
['ProductVariantsBulkDeleteUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `ProductVariantsBulkDeleteUserError`. */
['ProductVariantsBulkDeleteUserErrorCode']: ProductVariantsBulkDeleteUserErrorCode;
/** Specifies a product variant to create as part of a variant bulk mutation. */
['ProductVariantsBulkInput']: {
/** The value of the barcode associated with the product variant. */
barcode?: string | null;
/** The compare-at price of the variant. */
compareAtPrice?: ValueTypes['Money'] | null;
/** The ID of the fulfillment service associated with the variant. */
fulfillmentServiceId?: string | null;
/** The Harmonized System Code (or HS Tariff Code) for the variant. */
harmonizedSystemCode?: string | null;
/** Specifies the product variant to update or delete. */
id?: string | null;
/** The ID of the image that's associated with the variant. */
imageId?: string | null;
/** The URL of an image to associate with the variant. This field can only be used through mutations that create product images and must match one of the URLs being created on the product. */
imageSrc?: string | null;
/** The URL of the media to associate with the variant. */
mediaSrc?: string[];
/** Whether customers are allowed to place an order for the variant when it's out of stock. */
inventoryPolicy?: ValueTypes['ProductVariantInventoryPolicy'] | null;
/** Create only field. The inventory quantities at each location where the variant is stocked. The number of elements
in the array of inventory quantities cannot exceed 10 and the amount specified for the plan. */
inventoryQuantities?: ValueTypes['InventoryLevelInput'][];
/** The inventory item associated with the variant, used for unit cost. */
inventoryItem?: ValueTypes['InventoryItemInput'] | null;
/** The additional customizable information about the product variant. */
metafields?: ValueTypes['MetafieldInput'][];
/** The private metafields to associated with this product. */
privateMetafields?: ValueTypes['PrivateMetafieldInput'][];
/** The custom properties that a shop owner uses to define product variants. */
options?: string[];
/** The price of the variant. */
price?: ValueTypes['Money'] | null;
/** Whether the variant requires shipping. */
requiresShipping?: boolean | null;
/** The SKU for the variant. */
sku?: string | null;
/** Whether the variant is taxable. */
taxable?: boolean | null;
/** The tax code associated with the variant. */
taxCode?: string | null;
/** The weight of the variant. */
weight?: number | null;
/** The unit of weight that's used to measure the variant. */
weightUnit?: ValueTypes['WeightUnit'] | null;
};
/** Return type for `productVariantsBulkReorder` mutation. */
['ProductVariantsBulkReorderPayload']: AliasType<{
/** The updated product. */
product?: ValueTypes['Product'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['ProductVariantsBulkReorderUserError'];
__typename?: boolean;
}>;
/** Error codes for failed bulk product variants reorder operation. */
['ProductVariantsBulkReorderUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `ProductVariantsBulkReorderUserError`. */
['ProductVariantsBulkReorderUserErrorCode']: ProductVariantsBulkReorderUserErrorCode;
/** Return type for `productVariantsBulkUpdate` mutation. */
['ProductVariantsBulkUpdatePayload']: AliasType<{
/** The updated product object. */
product?: ValueTypes['Product'];
/** The updated variants. */
productVariants?: ValueTypes['ProductVariant'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['ProductVariantsBulkUpdateUserError'];
__typename?: boolean;
}>;
/** Error codes for failed variant bulk update mutations. */
['ProductVariantsBulkUpdateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `ProductVariantsBulkUpdateUserError`. */
['ProductVariantsBulkUpdateUserErrorCode']: ProductVariantsBulkUpdateUserErrorCode;
/** The set of valid sort keys for the ProfileItem query. */
['ProfileItemSortKeys']: ProfileItemSortKeys;
/** Return type for `pubSubWebhookSubscriptionCreate` mutation. */
['PubSubWebhookSubscriptionCreatePayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PubSubWebhookSubscriptionCreateUserError'];
/** The webhook subscription that was created. */
webhookSubscription?: ValueTypes['WebhookSubscription'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `PubSubWebhookSubscriptionCreate`. */
['PubSubWebhookSubscriptionCreateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `PubSubWebhookSubscriptionCreateUserError`. */
['PubSubWebhookSubscriptionCreateUserErrorCode']: PubSubWebhookSubscriptionCreateUserErrorCode;
/** Specifies the input fields for a PubSub webhook subscription. */
['PubSubWebhookSubscriptionInput']: {
/** The Pub/Sub project ID. */
pubSubProject: string;
/** The Pub/Sub topic ID. */
pubSubTopic: string;
/** The format in which the webhook subscription should send the data. */
format?: ValueTypes['WebhookSubscriptionFormat'] | null;
/** The list of fields to be included in the webhook subscription. */
includeFields?: string[];
/** The list of namespaces for any metafields that should be included in the webhook subscription. */
metafieldNamespaces?: string[];
};
/** Return type for `pubSubWebhookSubscriptionUpdate` mutation. */
['PubSubWebhookSubscriptionUpdatePayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['PubSubWebhookSubscriptionUpdateUserError'];
/** The webhook subscription that was updated. */
webhookSubscription?: ValueTypes['WebhookSubscription'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `PubSubWebhookSubscriptionUpdate`. */
['PubSubWebhookSubscriptionUpdateUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `PubSubWebhookSubscriptionUpdateUserError`. */
['PubSubWebhookSubscriptionUpdateUserErrorCode']: PubSubWebhookSubscriptionUpdateUserErrorCode;
/** A publication is a group of products and collections that is published to an app. */
['Publication']: AliasType<{
/** The app associated with the publication. */
app?: ValueTypes['App'];
collectionPublicationsV3?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationConnection']
];
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CollectionConnection']
];
hasCollection?: [
{
/** Collection ID to check. */
id: string;
},
boolean
];
/** A globally-unique identifier. */
id?: boolean;
/** Name of the publication. */
name?: boolean;
productPublicationsV3?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductConnection']
];
/** Whether or not this publication supports future publishing. */
supportsFuturePublishing?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple Publications. */
['PublicationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['PublicationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Publication and a cursor during pagination. */
['PublicationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of PublicationEdge. */
node?: ValueTypes['Publication'];
__typename?: boolean;
}>;
/** Specifies the input fields required to publish a resource. */
['PublicationInput']: {
/** ID of the channel. This argument is deprecated: Use publicationId instead. */
channelId?: string | null;
/** ID of the publication. */
publicationId?: string | null;
/** The date and time that the resource was published. Setting this to a date in the future will schedule
the resource to be published. Only online store channels support future publishing. */
publishDate?: ValueTypes['DateTime'] | null;
};
/** Represents a resource that can be published to a channel.
A publishable resource can be either a Product or Collection. */
['Publishable']: AliasType<{
/** The number of publications a resource is published to without feedback errors. */
availablePublicationCount?: boolean;
publicationCount?: [
{
/** Include only the resource's publications that are published. If false, then return all the resource's publications including future publications. */
onlyPublished?: boolean | null;
},
boolean
];
publishedOnChannel?: [
{
/** The ID of the channel to check. */
channelId: string;
},
boolean
];
/** Check to see whether the resource is published to the calling app's channel. */
publishedOnCurrentChannel?: boolean;
/** Check to see whether the resource is published to the calling app's publication. */
publishedOnCurrentPublication?: boolean;
publishedOnPublication?: [
{
/** The ID of the publication to check. */
publicationId: string;
},
boolean
];
resourcePublications?: [
{
/** Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationConnection']
];
resourcePublicationsV2?: [
{
/** Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published. */
onlyPublished?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ResourcePublicationV2Connection']
];
unpublishedChannels?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ChannelConnection']
];
unpublishedPublications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PublicationConnection']
];
['...on Collection']?: Omit<ValueTypes['Collection'], keyof ValueTypes['Publishable']>;
['...on Product']?: Omit<ValueTypes['Product'], keyof ValueTypes['Publishable']>;
__typename?: boolean;
}>;
/** Return type for `publishablePublish` mutation. */
['PublishablePublishPayload']: AliasType<{
/** Resource that has been published. */
publishable?: ValueTypes['Publishable'];
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `publishablePublishToCurrentChannel` mutation. */
['PublishablePublishToCurrentChannelPayload']: AliasType<{
/** Resource that has been published. */
publishable?: ValueTypes['Publishable'];
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `publishableUnpublish` mutation. */
['PublishableUnpublishPayload']: AliasType<{
/** Resource that has been unpublished. */
publishable?: ValueTypes['Publishable'];
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `publishableUnpublishToCurrentChannel` mutation. */
['PublishableUnpublishToCurrentChannelPayload']: AliasType<{
/** Resource that has been unpublished. */
publishable?: ValueTypes['Publishable'];
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Published translation of a field of a resource. */
['PublishedTranslation']: AliasType<{
/** The resource field that is being translated. */
key?: boolean;
/** The locale of this translation. */
locale?: boolean;
/** The translation value. */
value?: boolean;
__typename?: boolean;
}>;
/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */
['QueryRoot']: AliasType<{
app?: [
{
/** The ID to lookup the App by. */
id?: string | null;
},
ValueTypes['App']
];
appByHandle?: [
{
/** Handle of the App. */
handle: string;
},
ValueTypes['App']
];
appByKey?: [
{
/** API key of the App. */
apiKey: string;
},
ValueTypes['App']
];
appInstallation?: [
{
/** ID used to lookup AppInstallation. */
id?: string | null;
},
ValueTypes['AppInstallation']
];
appInstallations?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AppInstallationSortKeys'] | null /** The category of app installations to fetch. */;
category?: ValueTypes['AppInstallationCategory'] | null /** The privacy level of app installations to fetch. */;
privacy?: ValueTypes['AppInstallationPrivacy'] | null;
},
ValueTypes['AppInstallationConnection']
];
automaticDiscount?: [
{
/** The ID of the DiscountAutomatic to return. */
id: string;
},
ValueTypes['DiscountAutomatic']
];
automaticDiscountNode?: [
{
/** The ID of the DiscountAutomaticNode to return. */
id: string;
},
ValueTypes['DiscountAutomaticNode']
];
automaticDiscountNodes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AutomaticDiscountSortKeys'] | null /** Supported filter parameters:
- `status`
- `type`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['DiscountAutomaticNodeConnection']
];
automaticDiscountSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
automaticDiscounts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['AutomaticDiscountSortKeys'] | null /** Supported filter parameters:
- `status`
- `type`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['DiscountAutomaticConnection']
];
/** Returns a list of activated carrier services and associated shop locations that support them. */
availableCarrierServices?: ValueTypes['DeliveryCarrierServiceAndLocations'];
/** Returns a list of available locales. */
availableLocales?: ValueTypes['Locale'];
carrierService?: [
{
/** The ID of the DeliveryCarrierService to return. */
id: string;
},
ValueTypes['DeliveryCarrierService']
];
channel?: [
{
/** The ID of the Channel to return. */
id: string;
},
ValueTypes['Channel']
];
channels?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ChannelConnection']
];
codeDiscountNode?: [
{
/** The ID of the DiscountCodeNode to return. */
id: string;
},
ValueTypes['DiscountCodeNode']
];
codeDiscountNodeByCode?: [
{
/** The case-insensitive code of the `DiscountCodeNode` to return. */
code: string;
},
ValueTypes['DiscountCodeNode']
];
codeDiscountNodes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CodeDiscountSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `discount_type`
- `ends_at`
- `starts_at`
- `status`
- `times_used`
- `type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['DiscountCodeNodeConnection']
];
codeDiscountSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
collection?: [
{
/** The ID of the Collection to return. */
id: string;
},
ValueTypes['Collection']
];
collectionByHandle?: [
{
/** The handle of the collection. */
handle: string;
},
ValueTypes['Collection']
];
/** A list of rule conditions to define how collections with rules can be created. */
collectionRulesConditions?: ValueTypes['CollectionRuleConditions'];
collectionSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CollectionSortKeys'] | null /** Supported filter parameters:
- `collection_type`
- `publishable_status`
- `published_status`
- `title`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['CollectionConnection']
];
/** Return the AppInstallation for the currently authenticated App. */
currentAppInstallation?: ValueTypes['AppInstallation'];
currentBulkOperation?: [
{
/** The current bulk operation's type. */
type?: ValueTypes['BulkOperationType'] | null;
},
ValueTypes['BulkOperation']
];
customer?: [
{
/** The ID of the Customer to return. */
id: string;
},
ValueTypes['Customer']
];
customerPaymentMethod?: [
{
/** The ID of the CustomerPaymentMethod to return. */
id: string /** Whether to show the customer's revoked payment method. */;
showRevoked?: boolean | null;
},
ValueTypes['CustomerPaymentMethod']
];
customerSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CustomerSavedSearchSortKeys'] | null /** Supported filter parameters:
- `name`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['SavedSearchConnection']
];
customers?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CustomerSortKeys'] | null /** Supported filter parameters:
- `accepts_marketing`
- `country`
- `customer_date`
- `email`
- `last_abandoned_order_date`
- `order_date`
- `orders_count`
- `phone`
- `state`
- `tag`
- `tag_not`
- `total_spent`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['CustomerConnection']
];
deletionEvents?: [
{
/** List of subject types to filter by. */
subjectTypes?: ValueTypes['DeletionEventSubjectType'][] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DeletionEventSortKeys'] | null /** Supported filter parameters:
- `occurred_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['DeletionEventConnection']
];
deliveryProfile?: [
{
/** The ID of the DeliveryProfile to return. */
id: string;
},
ValueTypes['DeliveryProfile']
];
deliveryProfiles?: [
{
/** If `true`, returns only delivery profiles that were created by the merchant. */
merchantOwnedOnly?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['DeliveryProfileConnection']
];
/** Returns the shop-wide shipping settings. */
deliverySettings?: ValueTypes['DeliverySetting'];
discountCodeCount?: [
{
/** Supported filter parameters:
* times_used. */
query?: string | null;
},
boolean
];
discountRedeemCodeBulkCreation?: [
{
/** The ID of the DiscountRedeemCodeBulkCreation to return. */
id: string;
},
ValueTypes['DiscountRedeemCodeBulkCreation']
];
discountRedeemCodeSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DiscountCodeSortKeys'] | null /** Supported filter parameters:
- `times_used`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['SavedSearchConnection']
];
domain?: [
{
/** The ID of the Domain to return. */
id: string;
},
ValueTypes['Domain']
];
draftOrder?: [
{
/** The ID of the DraftOrder to return. */
id: string;
},
ValueTypes['DraftOrder']
];
draftOrderSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
draftOrders?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DraftOrderSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `customer_id`
- `status`
- `tag`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['DraftOrderConnection']
];
fileSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
files?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['FileSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `filename`
- `media_type`
- `original_upload_size`
- `status`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['FileConnection']
];
fulfillment?: [
{
/** The ID of the Fulfillment to return. */
id: string;
},
ValueTypes['Fulfillment']
];
fulfillmentOrder?: [
{
/** The ID of the FulfillmentOrder to return. */
id: string;
},
ValueTypes['FulfillmentOrder']
];
fulfillmentService?: [
{
/** The ID of the FulfillmentService to return. */
id: string;
},
ValueTypes['FulfillmentService']
];
giftCard?: [
{
/** The ID of the GiftCard to return. */
id: string;
},
ValueTypes['GiftCard']
];
giftCards?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['GiftCardSortKeys'] | null /** Supported filter parameters:
- `balance_status`
- `created_at`
- `expires_on`
- `initial_value`
- `source`
- `status`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['GiftCardConnection']
];
giftCardsCount?: [
{
/** Whether to count enabled or disabled or all gift cards. */
enabled?: boolean | null;
},
boolean
];
inventoryItem?: [
{
/** The ID of the InventoryItem to return. */
id: string;
},
ValueTypes['InventoryItem']
];
inventoryItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `created_at`
- `id`
- `sku`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['InventoryItemConnection']
];
inventoryLevel?: [
{
/** The ID of the InventoryLevel to return. */
id: string;
},
ValueTypes['InventoryLevel']
];
job?: [
{
/** ID of the job to query. */
id: string;
},
ValueTypes['Job']
];
location?: [
{
/** The ID of the location to return. If no ID is provided, the primary location of the Shop is returned. */
id?: string | null;
},
ValueTypes['Location']
];
locations?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['LocationSortKeys'] | null /** Supported filter parameters:
- `active`
- `address1`
- `address2`
- `city`
- `country`
- `legacy`
- `name`
- `province`
- `zip`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** If true, also include the legacy locations of fulfillment services. */;
includeLegacy?: boolean | null /** If true, also include the locations that are deactivated. */;
includeInactive?: boolean | null;
},
ValueTypes['LocationConnection']
];
/** Returns a list of all origin locations available for a delivery profile. */
locationsAvailableForDeliveryProfiles?: ValueTypes['Location'];
locationsAvailableForDeliveryProfilesConnection?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['LocationConnection']
];
marketingActivities?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MarketingActivitySortKeys'] | null /** Supported filter parameters:
- `app_id`
- `created_at`
- `marketing_campaign_id`
- `scheduled_to_end_at`
- `scheduled_to_start_at`
- `tactic`
- `title`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['MarketingActivityConnection']
];
marketingActivity?: [
{
/** The ID of the MarketingActivity to return. */
id: string;
},
ValueTypes['MarketingActivity']
];
marketingEvent?: [
{
/** The ID of the MarketingEvent to return. */
id: string;
},
ValueTypes['MarketingEvent']
];
marketingEvents?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MarketingEventSortKeys'] | null /** Supported filter parameters:
- `app_id`
- `description`
- `started_at`
- `type`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MarketingEventConnection']
];
metafield?: [
{
/** The ID of the Metafield to return. */
id: string;
},
ValueTypes['Metafield']
];
metafieldDefinition?: [
{
/** The ID of the MetafieldDefinition to return. */
id: string;
},
ValueTypes['MetafieldDefinition']
];
/** Each metafield definition has a type, which defines the type of information that it can store.
This type is enforced across every instance of the resource that owns the metafield definition.
Refer to the [list of supported metafield types](https://shopify.dev/apps/metafields/types). */
metafieldDefinitionTypes?: ValueTypes['MetafieldDefinitionType'];
metafieldDefinitions?: [
{
/** Filter metafield definition by key. */
key?: string | null /** Filter metafield definition by namespace. */;
namespace?: string | null /** Filter the metafield definition by the specific owner type. */;
ownerType: ValueTypes['MetafieldOwnerType'] /** Filter the metafield definition by the pinned status. */;
pinnedStatus?: ValueTypes['MetafieldDefinitionPinnedStatus'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MetafieldDefinitionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `key`
- `namespace`
- `owner_type`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MetafieldDefinitionConnection']
];
metafieldStorefrontVisibilities?: [
{
/** Filter the visible metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldStorefrontVisibilityConnection']
];
metafieldStorefrontVisibility?: [
{
/** The ID of the MetafieldStorefrontVisibility to return. */
id: string;
},
ValueTypes['MetafieldStorefrontVisibility']
];
node?: [
{
/** The ID of the Node to return. */
id: string;
},
ValueTypes['Node']
];
nodes?: [
{
/** The IDs of the Nodes to return. */
ids: string[];
},
ValueTypes['Node']
];
order?: [
{
/** The ID of the Order to return. */
id: string;
},
ValueTypes['Order']
];
orderSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
orders?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['OrderSortKeys'] | null /** Supported filter parameters:
- `cart_token`
- `channel`
- `channel_id`
- `chargeback_status`
- `checkout_token`
- `created_at`
- `credit_card_last4`
- `customer_id`
- `delivery_method`
- `discount_code`
- `earliest_fulfill_by`
- `email`
- `financial_status`
- `fraud_protection_level`
- `fulfillment_location_id`
- `fulfillment_status`
- `gateway`
- `location_id`
- `name`
- `payment_provider_id`
- `processed_at`
- `reference_location_id`
- `return_status`
- `risk_level`
- `sales_channel`
- `source_identifier`
- `source_name`
- `status`
- `tag`
- `tag_not`
- `test`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['OrderConnection']
];
paymentTermsTemplates?: [
{
/** The payment terms type to filter the payment terms templates list. */
paymentTermsType?: ValueTypes['PaymentTermsType'] | null;
},
ValueTypes['PaymentTermsTemplate']
];
priceList?: [
{
/** The ID of the `PriceList` to return. */
id: string;
},
ValueTypes['PriceList']
];
priceLists?: [
{
/** The context that the price list applies to. */
matchRule?: ValueTypes['PriceListContext'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['PriceListSortKeys'] | null;
},
ValueTypes['PriceListConnection']
];
priceRule?: [
{
/** The ID of the PriceRule to return. */
id: string;
},
ValueTypes['PriceRule']
];
priceRuleSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
priceRules?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['PriceRuleSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `discount_type`
- `ends_at`
- `starts_at`
- `status`
- `times_used`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['PriceRuleConnection']
];
privateMetafield?: [
{
/** The ID of the PrivateMetafield to return. */
id: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Retrieve the private metafields of a certain resource, specified by the resource ID. */;
owner: string /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
product?: [
{
/** The ID of the Product to return. */
id: string;
},
ValueTypes['Product']
];
productByHandle?: [
{
/** The handle of the product. */
handle: string;
},
ValueTypes['Product']
];
productResourceFeedback?: [
{
/** The product associated with the resource feedback. */
id: string;
},
ValueTypes['ProductResourceFeedback']
];
productSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
productVariant?: [
{
/** The ID of the ProductVariant to return. */
id: string;
},
ValueTypes['ProductVariant']
];
productVariants?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductVariantSortKeys'] | null /** Supported filter parameters:
- `barcode`
- `collection`
- `delivery_profile_id`
- `exclude_composite`
- `gift_card`
- `inventory_quantity`
- `location_id`
- `managed`
- `managed_by`
- `product_id`
- `product_status`
- `product_type`
- `publishable_status`
- `published_status`
- `sku`
- `tag`
- `tag_not`
- `taxable`
- `title`
- `updated_at`
- `vendor`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['ProductVariantConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductSortKeys'] | null /** Supported filter parameters:
- `barcode`
- `created_at`
- `delivery_profile_id`
- `error_feedback`
- `gift_card`
- `has_only_composites`
- `has_only_default_variant`
- `id`
- `inventory_total`
- `is_price_reduced`
- `out_of_stock_somewhere`
- `price`
- `product_type`
- `publishable_status`
- `published_status`
- `sku`
- `status`
- `tag`
- `tag_not`
- `title`
- `updated_at`
- `vendor`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['ProductConnection']
];
/** The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions. */
publicApiVersions?: ValueTypes['ApiVersion'];
publication?: [
{
/** The ID of the Publication to return. */
id: string;
},
ValueTypes['Publication']
];
publications?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PublicationConnection']
];
refund?: [
{
/** The ID of the Refund to return. */
id: string;
},
ValueTypes['Refund']
];
scriptTag?: [
{
/** The ID of the ScriptTag to return. */
id: string;
},
ValueTypes['ScriptTag']
];
scriptTags?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** The source URL of the script tag to filter by. */;
src?: ValueTypes['URL'] | null;
},
ValueTypes['ScriptTagConnection']
];
sellingPlanGroup?: [
{
/** The ID of the SellingPlanGroup to return. */
id: string;
},
ValueTypes['SellingPlanGroup']
];
sellingPlanGroups?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['SellingPlanGroupSortKeys'] | null /** Supported filter parameters:
- `delivery_frequency`
- `percentage_off`
- `name`
- `created_at`
- `app_id [CURRENT|ALL|App ID number]` default: `CURRENT`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax). */;
query?: string | null;
},
ValueTypes['SellingPlanGroupConnection']
];
/** Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains
business and store management settings for the shop. */
shop?: ValueTypes['Shop'];
shopLocales?: [
{
/** Return only published locales. */
published?: boolean | null;
},
ValueTypes['ShopLocale']
];
/** Shopify Payments account information, including balances and payouts. */
shopifyPaymentsAccount?: ValueTypes['ShopifyPaymentsAccount'];
standardMetafieldDefinitionTemplates?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['StandardMetafieldDefinitionTemplateConnection']
];
subscriptionBillingAttempt?: [
{
/** The ID of the SubscriptionBillingAttempt to return. */
id: string;
},
ValueTypes['SubscriptionBillingAttempt']
];
subscriptionContract?: [
{
/** The ID of the Subscription Contract to return. */
id: string;
},
ValueTypes['SubscriptionContract']
];
subscriptionContracts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionContractConnection']
];
subscriptionDraft?: [
{
/** The ID of the Subscription Draft to return. */
id: string;
},
ValueTypes['SubscriptionDraft']
];
tenderTransactions?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `point_of_sale_device_id`
- `processed_at`
- `test`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['TenderTransactionConnection']
];
translatableResource?: [
{
/** Find a translatable resource by ID. */
resourceId: string;
},
ValueTypes['TranslatableResource']
];
translatableResources?: [
{
/** Return only resources of a type. */
resourceType: ValueTypes['TranslatableResourceType'] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['TranslatableResourceConnection']
];
translatableResourcesByIds?: [
{
/** Return only resources for given IDs. */
resourceIds: string[] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['TranslatableResourceConnection']
];
urlRedirect?: [
{
/** The ID of the UrlRedirect to return. */
id: string;
},
ValueTypes['UrlRedirect']
];
urlRedirectImport?: [
{
/** The ID of the UrlRedirectImport to return. */
id: string;
},
ValueTypes['UrlRedirectImport']
];
urlRedirectSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
urlRedirects?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['UrlRedirectSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `path`
- `target`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['UrlRedirectConnection']
];
webhookSubscription?: [
{
/** The ID of the WebhookSubscription to return. */
id: string;
},
ValueTypes['WebhookSubscription']
];
webhookSubscriptions?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['WebhookSubscriptionSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** Callback URL to filter by. */;
callbackUrl?: ValueTypes['URL'] | null /** Response format to filter by. */;
format?: ValueTypes['WebhookSubscriptionFormat'] | null /** List of webhook subscription topics to filter by. */;
topics?: ValueTypes['WebhookSubscriptionTopic'][];
},
ValueTypes['WebhookSubscriptionConnection']
];
__typename?: boolean;
}>;
/** The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items. */
['Refund']: AliasType<{
/** The date and time when the refund was created. */
createdAt?: boolean;
/** A list of the refunded duties as part of this refund. */
duties?: ValueTypes['RefundDuty'];
/** A globally-unique identifier. */
id?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The optional note associated with the refund. */
note?: boolean;
/** The order associated with the refund. */
order?: ValueTypes['Order'];
refundLineItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['RefundLineItemConnection']
];
/** The total amount across all transactions for the refund. */
totalRefunded?: ValueTypes['MoneyV2'];
/** The total amount across all transactions for the refund, in shop and presentment currencies. */
totalRefundedSet?: ValueTypes['MoneyBag'];
transactions?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['OrderTransactionConnection']
];
/** The date and time when the refund was updated. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** An agreement between the merchant and customer to refund all or a portion of the order. */
['RefundAgreement']: AliasType<{
/** The application that created the agreement. */
app?: ValueTypes['App'];
/** The date and time at which the agreement occured. */
happenedAt?: boolean;
/** The unique identifier for the agreement. */
id?: boolean;
/** The reason the agremeent was created. */
reason?: boolean;
/** The refund associated with the agreement. */
refund?: ValueTypes['Refund'];
sales?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SaleConnection']
];
__typename?: boolean;
}>;
/** Return type for `refundCreate` mutation. */
['RefundCreatePayload']: AliasType<{
/** The order associated with the created refund. */
order?: ValueTypes['Order'];
/** The created refund. */
refund?: ValueTypes['Refund'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents a refunded duty. */
['RefundDuty']: AliasType<{
/** The amount of a refunded duty in shop and presentment currencies. */
amountSet?: ValueTypes['MoneyBag'];
/** The duty associated with this refunded duty. */
originalDuty?: ValueTypes['Duty'];
__typename?: boolean;
}>;
/** The fields required to reimburse duties on a refund. */
['RefundDutyInput']: {
/** The ID of the duty in the refund. */
dutyId: string;
/** The type of refund for this duty. */
refundType?: ValueTypes['RefundDutyRefundType'] | null;
};
/** The type of refund to perform for a particular refund duty. */
['RefundDutyRefundType']: RefundDutyRefundType;
/** The input fields to create a refund. */
['RefundInput']: {
/** The currency that is used to refund the order. This must be the presentment currency, which is the currency used by the customer. This is a required field for orders where the currency and presentment currency differ. */
currency?: ValueTypes['CurrencyCode'] | null;
/** The ID of the order that is being refunded. */
orderId: string;
/** An optional note that is attached to the refund. */
note?: string | null;
/** Whether to send a refund notification to the customer. */
notify?: boolean | null;
/** The input fields that are required to reimburse shipping costs. */
shipping?: ValueTypes['ShippingRefundInput'] | null;
/** A list of line items to refund. */
refundLineItems?: ValueTypes['RefundLineItemInput'][];
/** A list of duties to refund. */
refundDuties?: ValueTypes['RefundDutyInput'][];
/** A list of transactions involved in the refund. */
transactions?: ValueTypes['OrderTransactionInput'][];
};
/** A line item that's included in a refund. */
['RefundLineItem']: AliasType<{
/** The `LineItem` resource associated to the refunded line item. */
lineItem?: ValueTypes['LineItem'];
/** The inventory restock location. */
location?: ValueTypes['Location'];
/** The price of a refunded line item. */
price?: boolean;
/** The price of a refunded line item in shop and presentment currencies. */
priceSet?: ValueTypes['MoneyBag'];
/** The quantity of a refunded line item. */
quantity?: boolean;
/** The type of restock for the refunded line item. */
restockType?: boolean;
/** Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund. */
restocked?: boolean;
/** The subtotal price of a refunded line item. */
subtotal?: boolean;
/** The subtotal price of a refunded line item in shop and presentment currencies. */
subtotalSet?: ValueTypes['MoneyBag'];
/** The total tax charged on a refunded line item. */
totalTax?: boolean;
/** The total tax charged on a refunded line item in shop and presentment currencies. */
totalTaxSet?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple RefundLineItems. */
['RefundLineItemConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['RefundLineItemEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one RefundLineItem and a cursor during pagination. */
['RefundLineItemEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of RefundLineItemEdge. */
node?: ValueTypes['RefundLineItem'];
__typename?: boolean;
}>;
/** The fields required to reimburse line items on a refund. */
['RefundLineItemInput']: {
/** The ID of the line item in the refund. */
lineItemId: string;
/** The quantity of the associated line item to be refunded. */
quantity: number;
/** The type of restock for this line item. */
restockType?: ValueTypes['RefundLineItemRestockType'] | null;
/** The intended location for restocking. If the `restockType` is set to `NO_RESTOCK`, then this value is empty.` */
locationId?: string | null;
};
/** The type of restock performed for a particular refund line item. */
['RefundLineItemRestockType']: RefundLineItemRestockType;
/** Input for a remote Authorize.net customer payment profile. */
['RemoteAuthorizeNetCustomerPaymentProfileInput']: {
/** The customerProfileId value from the Authorize.net API. */
customerProfileId: string;
/** The customerPaymentProfileId value from the Authorize.net API. */
customerPaymentProfileId?: string | null;
};
/** Input for a remote stripe payment method. */
['RemoteStripePaymentMethodInput']: {
/** The customer_id value from the Stripe API. */
customerId: string;
/** The payment_method_id value from the Stripe API. */
paymentMethodId?: string | null;
};
/** An alert message that appears in the Shopify admin about a problem with a store resource, with 1 or more actions to take. For example, you could use an alert to indicate that you're not charging taxes on some product variants.
They can optionally have a specific icon and be dismissed by merchants. */
['ResourceAlert']: AliasType<{
/** Buttons in the alert that link to related information.
For example, _Edit variants_. */
actions?: ValueTypes['ResourceAlertAction'];
/** The secondary text in the alert that includes further information or instructions about how to solve a problem. */
content?: boolean;
/** Unique identifier that appears when an alert is manually closed by the merchant.
Most alerts cannot be manually closed. */
dismissibleHandle?: boolean;
/** An icon that is optionally displayed with the alert. */
icon?: boolean;
/** Indication of how important the alert is. */
severity?: boolean;
/** The primary text in the alert that includes information or describes the problem. */
title?: boolean;
__typename?: boolean;
}>;
/** An action associated to a resource alert, such as editing variants. */
['ResourceAlertAction']: AliasType<{
/** Whether the action appears as a button or as a link. */
primary?: boolean;
/** Resource for the action to show. */
show?: boolean;
/** The text for the button in the alert. For example, _Edit variants_. */
title?: boolean;
/** The target URL that the button links to. */
url?: boolean;
__typename?: boolean;
}>;
/** The available icons for resource alerts. */
['ResourceAlertIcon']: ResourceAlertIcon;
/** The possible severity levels for a resource alert. */
['ResourceAlertSeverity']: ResourceAlertSeverity;
/** Represents feedback from apps about a resource, and the steps required to set up the apps on the shop. */
['ResourceFeedback']: AliasType<{
/** Feedback from an app about the steps a merchant needs to take to set up the app on their store. */
appFeedback?: ValueTypes['AppFeedback'];
/** List of AppFeedback detailing issues regarding a resource. */
details?: ValueTypes['AppFeedback'];
/** Summary of resource feedback pertaining to the resource. */
summary?: boolean;
__typename?: boolean;
}>;
/** The state of the resource feedback. */
['ResourceFeedbackState']: ResourceFeedbackState;
/** A resource limit represents the limits that the resource has. */
['ResourceLimit']: AliasType<{
/** Whether or not the resource is available. */
available?: boolean;
/** Quantity available. If null the quantity available is unlimited. */
quantityAvailable?: boolean;
/** Quantity limit of the resource. If null the quantity is unlimited. */
quantityLimit?: boolean;
/** Quantity used of the resource. If null the quantity used cannot be retrieved. */
quantityUsed?: boolean;
__typename?: boolean;
}>;
/** A resource publication represents that a resource has been published to a publication. */
['ResourcePublication']: AliasType<{
/** The channel the resource publication is published to. */
channel?: ValueTypes['Channel'];
/** Whether the resource publication is published. Also returns true if the resource publication is scheduled to be published.
If false, then the resource publication is neither published nor scheduled to be published. */
isPublished?: boolean;
/** The publication the resource publication is published to. */
publication?: ValueTypes['Publication'];
/** The date that the resource publication was or is going to be published to the publication. */
publishDate?: boolean;
/** The resource published to the publication. */
publishable?: ValueTypes['Publishable'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ResourcePublications. */
['ResourcePublicationConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ResourcePublicationEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ResourcePublication and a cursor during pagination. */
['ResourcePublicationEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ResourcePublicationEdge. */
node?: ValueTypes['ResourcePublication'];
__typename?: boolean;
}>;
/** A resource publication represents that a resource either has been published or will be published to a publication. */
['ResourcePublicationV2']: AliasType<{
/** Whether the resource publication is published. If true, then the resource publication is published to the publication.
If false, then the resource publication is staged to be published to the publication. */
isPublished?: boolean;
/** The publication the resource publication is published to. */
publication?: ValueTypes['Publication'];
/** The date that the resource publication was or is going to be published to the publication. */
publishDate?: boolean;
/** The resource published to the publication. */
publishable?: ValueTypes['Publishable'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ResourcePublicationV2s. */
['ResourcePublicationV2Connection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ResourcePublicationV2Edge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ResourcePublicationV2 and a cursor during pagination. */
['ResourcePublicationV2Edge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ResourcePublicationV2Edge. */
node?: ValueTypes['ResourcePublicationV2'];
__typename?: boolean;
}>;
/** SEO information. */
['SEO']: AliasType<{
/** SEO Description. */
description?: boolean;
/** SEO Title. */
title?: boolean;
__typename?: boolean;
}>;
/** SEO information. */
['SEOInput']: {
/** SEO title of the product. */
title?: string | null;
/** SEO description of the product. */
description?: string | null;
};
/** An individual sale record associated with a sales agreement. */
['Sale']: AliasType<{
/** The type of order action that the sale represents. */
actionType?: boolean;
/** The unique identifier for the sale. */
id?: boolean;
/** The line type assocated with the sale. */
lineType?: boolean;
/** The number of units either ordered or intended to be returned. */
quantity?: boolean;
/** All individual taxes associated with the sale. */
taxes?: ValueTypes['SaleTax'];
/** The total sale amount after taxes and discounts. */
totalAmount?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale after taxes. */
totalDiscountAmountAfterTaxes?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale before taxes. */
totalDiscountAmountBeforeTaxes?: ValueTypes['MoneyBag'];
/** The total amount of taxes for the sale. */
totalTaxAmount?: ValueTypes['MoneyBag'];
['...on AdjustmentSale']?: Omit<ValueTypes['AdjustmentSale'], keyof ValueTypes['Sale']>;
['...on DutySale']?: Omit<ValueTypes['DutySale'], keyof ValueTypes['Sale']>;
['...on GiftCardSale']?: Omit<ValueTypes['GiftCardSale'], keyof ValueTypes['Sale']>;
['...on ProductSale']?: Omit<ValueTypes['ProductSale'], keyof ValueTypes['Sale']>;
['...on ShippingLineSale']?: Omit<ValueTypes['ShippingLineSale'], keyof ValueTypes['Sale']>;
['...on TipSale']?: Omit<ValueTypes['TipSale'], keyof ValueTypes['Sale']>;
__typename?: boolean;
}>;
/** The possible order action types for a sale. */
['SaleActionType']: SaleActionType;
/** An auto-generated type for paginating through multiple Sales. */
['SaleConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SaleEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one Sale and a cursor during pagination. */
['SaleEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SaleEdge. */
node?: ValueTypes['Sale'];
__typename?: boolean;
}>;
/** The possible line types for a sale record. */
['SaleLineType']: SaleLineType;
/** The tax allocated to a sale from a single tax line. */
['SaleTax']: AliasType<{
/** The portion of the total tax amount on the related sale that comes from the associated tax line. */
amount?: ValueTypes['MoneyBag'];
/** The unique identifier for the sale tax. */
id?: boolean;
/** The tax line associated with the sale. */
taxLine?: ValueTypes['TaxLine'];
__typename?: boolean;
}>;
/** An addition, removal, modification, or other sale commitment associated with an order. */
['SalesAgreement']: AliasType<{
/** The application that created the agreement. */
app?: ValueTypes['App'];
/** The date and time at which the agreement occured. */
happenedAt?: boolean;
/** The unique identifier for the agreement. */
id?: boolean;
/** The reason the agremeent was created. */
reason?: boolean;
sales?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SaleConnection']
];
['...on OrderAgreement']?: Omit<ValueTypes['OrderAgreement'], keyof ValueTypes['SalesAgreement']>;
['...on OrderEditAgreement']?: Omit<ValueTypes['OrderEditAgreement'], keyof ValueTypes['SalesAgreement']>;
['...on RefundAgreement']?: Omit<ValueTypes['RefundAgreement'], keyof ValueTypes['SalesAgreement']>;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SalesAgreements. */
['SalesAgreementConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SalesAgreementEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SalesAgreement and a cursor during pagination. */
['SalesAgreementEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SalesAgreementEdge. */
node?: ValueTypes['SalesAgreement'];
__typename?: boolean;
}>;
/** A saved search is a representation of a search query saved in the admin. */
['SavedSearch']: AliasType<{
/** The filters of a saved search. */
filters?: ValueTypes['SearchFilter'];
/** A globally-unique identifier. */
id?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The name of a saved search. */
name?: boolean;
/** The query string of a saved search. This includes search terms and filters. */
query?: boolean;
/** The type of resource this saved search is searching in. */
resourceType?: boolean;
/** The search terms of a saved search. */
searchTerms?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SavedSearches. */
['SavedSearchConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SavedSearchEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Specifies the fields required to create a saved search. */
['SavedSearchCreateInput']: {
/** The type of resource this saved search is searching in. */
resourceType: ValueTypes['SearchResultType'];
/** A descriptive name of the saved search. */
name: string;
/** The query string of a saved search. This includes search terms and filters. */
query: string;
};
/** Return type for `savedSearchCreate` mutation. */
['SavedSearchCreatePayload']: AliasType<{
/** The saved search that was created. */
savedSearch?: ValueTypes['SavedSearch'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the fields to delete a saved search. */
['SavedSearchDeleteInput']: {
/** ID of the saved search to delete. */
id: string;
};
/** Return type for `savedSearchDelete` mutation. */
['SavedSearchDeletePayload']: AliasType<{
/** The id of the saved search that was deleted. */
deletedSavedSearchId?: boolean;
/** The shop of the saved search that was deleted. */
shop?: ValueTypes['Shop'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SavedSearch and a cursor during pagination. */
['SavedSearchEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SavedSearchEdge. */
node?: ValueTypes['SavedSearch'];
__typename?: boolean;
}>;
/** Specifies the fields required to update a saved search. */
['SavedSearchUpdateInput']: {
/** ID of the saved search to update. */
id: string;
/** A descriptive name of the saved search. */
name?: string | null;
/** The query string of a saved search. This included search terms and filters. */
query?: string | null;
};
/** Return type for `savedSearchUpdate` mutation. */
['SavedSearchUpdatePayload']: AliasType<{
/** The saved search that was updated. */
savedSearch?: ValueTypes['SavedSearch'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Script discount applications capture the intentions of a discount that
was created by a Shopify Script for an order's line item or shipping line. */
['ScriptDiscountApplication']: AliasType<{
/** The method by which the discount's value is allocated to its entitled items. */
allocationMethod?: boolean;
/** The description of the application as defined by the Script. */
description?: boolean;
/** An ordered index that can be used to identify the discount application and indicate the precedence
of the discount application for calculations. */
index?: boolean;
/** How the discount amount is distributed on the discounted lines. */
targetSelection?: boolean;
/** Whether the discount is applied on line items or shipping lines. */
targetType?: boolean;
/** The title of the application as defined by the Script. */
title?: boolean;
/** The value of the discount application. */
value?: ValueTypes['PricingValue'];
__typename?: boolean;
}>;
/** A script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the order status page of checkout. */
['ScriptTag']: AliasType<{
/** Whether the Shopify CDN can cache and serve the script tag.
If `true`, then the script will be cached and served by the CDN.
The cache expires 15 minutes after the script tag is successfully returned.
If `false`, then the script will be served as is. */
cache?: boolean;
/** The date and time when the script tag was created. */
createdAt?: boolean;
/** The page or pages on the online store that the script should be included. */
displayScope?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The URL to the remote script. */
src?: boolean;
/** The date and time when the script tag was last updated. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ScriptTags. */
['ScriptTagConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ScriptTagEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `scriptTagCreate` mutation. */
['ScriptTagCreatePayload']: AliasType<{
/** The script tag that was created. */
scriptTag?: ValueTypes['ScriptTag'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `scriptTagDelete` mutation. */
['ScriptTagDeletePayload']: AliasType<{
/** The ID of the deleted script tag. */
deletedScriptTagId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The page or pages on the online store where the script should be included. */
['ScriptTagDisplayScope']: ScriptTagDisplayScope;
/** An auto-generated type which holds one ScriptTag and a cursor during pagination. */
['ScriptTagEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ScriptTagEdge. */
node?: ValueTypes['ScriptTag'];
__typename?: boolean;
}>;
/** The input fields for a script tag. This input object is used when creating or updating
a script tag to specify its URL, where it should be included, and how it will be cached. */
['ScriptTagInput']: {
/** The URL of the remote script. For example: `https://example.com/path/to/script.js`. */
src?: ValueTypes['URL'] | null;
/** The page or pages on the online store where the script should be included. */
displayScope?: ValueTypes['ScriptTagDisplayScope'] | null;
/** Whether the Shopify CDN can cache and serve the script tag.
If `true`, then the script will be cached and served by the CDN.
The cache expires 15 minutes after the script tag is successfully returned.
If `false`, then the script is served as is.
The default value is `false`. */
cache?: boolean | null;
};
/** Return type for `scriptTagUpdate` mutation. */
['ScriptTagUpdatePayload']: AliasType<{
/** The script tag that was updated. */
scriptTag?: ValueTypes['ScriptTag'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** A filter in a search query represented by a key value pair. */
['SearchFilter']: AliasType<{
/** The key of the search filter. */
key?: boolean;
/** The value of the search filter. */
value?: boolean;
__typename?: boolean;
}>;
/** A list of search filters along with their specific options in value and label pair for filtering. */
['SearchFilterOptions']: AliasType<{
/** A list of options that can be use to filter product availability. */
productAvailability?: ValueTypes['FilterOption'];
__typename?: boolean;
}>;
/** Represents an individual result returned from a search. */
['SearchResult']: AliasType<{
/** Returns the search result description text. */
description?: boolean;
/** Returns the Image resource presented to accompany a search result. */
image?: ValueTypes['Image'];
/** Returns the ID of the resource returned in the search result. */
reference?: ValueTypes['Node'];
/** Returns the resource title. */
title?: boolean;
/** Returns the absolute URL to the resource in the search result. */
url?: boolean;
__typename?: boolean;
}>;
/** The connection type for SearchResult. */
['SearchResultConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SearchResultEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
/** Information to aid in pagination. */
resultsAfterCount?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type which holds one SearchResult and a cursor during pagination. */
['SearchResultEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SearchResultEdge. */
node?: ValueTypes['SearchResult'];
__typename?: boolean;
}>;
/** Specifies the type of resources to be returned from a search. */
['SearchResultType']: SearchResultType;
/** Properties used by customers to select a product variant.
Products can have multiple options, like different sizes or colors. */
['SelectedOption']: AliasType<{
/** The product option’s name. */
name?: boolean;
/** The product option’s value. */
value?: boolean;
__typename?: boolean;
}>;
/** Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups
and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing
up these records if you need to restore them later.
For more information on selling plans, refer to
[*Creating and managing selling plans*](https://shopify.dev/apps/subscriptions/selling-plans). */
['SellingPlan']: AliasType<{
/** A selling plan policy which describes the recurring billing details. */
billingPolicy?: ValueTypes['SellingPlanBillingPolicy'];
/** The date and time when the selling plan was created. */
createdAt?: boolean;
/** A selling plan policy which describes the delivery details. */
deliveryPolicy?: ValueTypes['SellingPlanDeliveryPolicy'];
/** Buyer facing string which describes the selling plan commitment. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** A customer-facing description of the selling plan.
If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies. */
name?: boolean;
/** The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */
options?: boolean;
/** Relative position of the selling plan for display. A lower position will be displayed before a higher position. */
position?: boolean;
/** Selling plan pricing details. */
pricingPolicies?: ValueTypes['SellingPlanPricingPolicy'];
__typename?: boolean;
}>;
/** Represents a selling plan policy anchor. */
['SellingPlanAnchor']: AliasType<{
/** The day of the anchor.
If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets
the days of the week according to ISO 8601, where 1 is Monday.
If `type` is not WEEKDAY, then the value must be between 1-31. */
day?: boolean;
/** The month of the anchor. If type is different than YEARDAY, this field must be null, otherwise it must be
between 1-12. */
month?: boolean;
/** Represents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY. */
type?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a selling plan anchor. */
['SellingPlanAnchorInput']: {
/** Represents the anchor type, must be one of WEEKDAY, MONTHDAY, YEARDAY. */
type?: ValueTypes['SellingPlanAnchorType'] | null;
/** The day of the anchor.
If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets
the days of the week according to ISO 8601, where 1 is Monday.
If `type` is not WEEKDAY, then the value must be between 1-31. */
day?: number | null;
/** The month of the anchor. If type is different than YEARDAY, this field must be null, otherwise it must be
between 1-12. */
month?: number | null;
};
/** Represents the anchor type. */
['SellingPlanAnchorType']: SellingPlanAnchorType;
/** Represents the billing frequency associated to the selling plan (for example, bill every week, or bill every
three months). The selling plan billing policy and associated records (selling plan groups, selling plans, pricing
policies, and delivery policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.
We recommend backing up these records if you need to restore them later. */
['SellingPlanBillingPolicy']: AliasType<{
['...on SellingPlanRecurringBillingPolicy']: ValueTypes['SellingPlanRecurringBillingPolicy'];
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a billing policy type. */
['SellingPlanBillingPolicyInput']: {
/** The recurring billing policy details. */
recurring?: ValueTypes['SellingPlanRecurringBillingPolicyInput'] | null;
};
/** An auto-generated type for paginating through multiple SellingPlans. */
['SellingPlanConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SellingPlanEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver
every other week). The selling plan delivery policy and associated records (selling plan groups, selling plans,
pricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.
We recommend backing up these records if you need to restore them later. */
['SellingPlanDeliveryPolicy']: AliasType<{
['...on SellingPlanRecurringDeliveryPolicy']: ValueTypes['SellingPlanRecurringDeliveryPolicy'];
__typename?: boolean;
}>;
/** Specifies the input fields to create or update a delivery policy. */
['SellingPlanDeliveryPolicyInput']: {
/** The recurring delivery policy details. */
recurring?: ValueTypes['SellingPlanRecurringDeliveryPolicyInput'] | null;
};
/** An auto-generated type which holds one SellingPlan and a cursor during pagination. */
['SellingPlanEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SellingPlanEdge. */
node?: ValueTypes['SellingPlan'];
__typename?: boolean;
}>;
/** Represents a fixed selling plan pricing policy. */
['SellingPlanFixedPricingPolicy']: AliasType<{
/** The price adjustment type. */
adjustmentType?: boolean;
/** The price adjustment value. */
adjustmentValue?: ValueTypes['SellingPlanPricingPolicyAdjustmentValue'];
/** The date and time when the fixed selling plan pricing policy was created. */
createdAt?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a fixed selling plan pricing policy. */
['SellingPlanFixedPricingPolicyInput']: {
/** ID of the pricing policy. */
id?: string | null;
/** Price adjustment type defined by the policy. */
adjustmentType?: ValueTypes['SellingPlanPricingPolicyAdjustmentType'] | null;
/** Price adjustment value defined by the policy. */
adjustmentValue?: ValueTypes['SellingPlanPricingPolicyValueInput'] | null;
};
/** Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups
and associated records (selling plans and policies) are deleted 48 hours after a merchant
uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. */
['SellingPlanGroup']: AliasType<{
/** The identifier for app, exposed in Liquid and product JSON. */
appId?: boolean;
appliesToProduct?: [
{
/** The ID of the product. */
productId: string;
},
boolean
];
appliesToProductVariant?: [
{
/** The ID of the product. */
productVariantId: string;
},
boolean
];
appliesToProductVariants?: [
{
/** The ID of the product. */
productId: string;
},
boolean
];
/** The date and time when the selling plan group was created. */
createdAt?: boolean;
/** The merchant-facing description of the selling plan group. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The merchant-facing label of the selling plan group. */
merchantCode?: boolean;
/** The buyer-facing label of the selling plan group. */
name?: boolean;
/** The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */
options?: boolean;
/** The relative position of the selling plan group for display. */
position?: boolean;
/** A count of products associated to the selling plan group. */
productCount?: boolean;
productVariantCount?: [
{
/** The ID of the product to scope the count to. */
productId?: string | null;
},
boolean
];
productVariants?: [
{
/** Filters the product variants by a product ID. */
productId?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductVariantConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ProductConnection']
];
sellingPlans?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SellingPlanConnection']
];
/** A summary of the policies associated to the selling plan group. */
summary?: boolean;
__typename?: boolean;
}>;
/** Return type for `sellingPlanGroupAddProductVariants` mutation. */
['SellingPlanGroupAddProductVariantsPayload']: AliasType<{
/** The updated selling plan group. */
sellingPlanGroup?: ValueTypes['SellingPlanGroup'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Return type for `sellingPlanGroupAddProducts` mutation. */
['SellingPlanGroupAddProductsPayload']: AliasType<{
/** The updated selling plan group. */
sellingPlanGroup?: ValueTypes['SellingPlanGroup'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SellingPlanGroups. */
['SellingPlanGroupConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SellingPlanGroupEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `sellingPlanGroupCreate` mutation. */
['SellingPlanGroupCreatePayload']: AliasType<{
/** The created selling plan group object. */
sellingPlanGroup?: ValueTypes['SellingPlanGroup'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Return type for `sellingPlanGroupDelete` mutation. */
['SellingPlanGroupDeletePayload']: AliasType<{
/** The id of the deleted selling plan group object. */
deletedSellingPlanGroupId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. */
['SellingPlanGroupEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SellingPlanGroupEdge. */
node?: ValueTypes['SellingPlanGroup'];
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a selling plan group. */
['SellingPlanGroupInput']: {
/** Buyer facing label of the selling plan group. */
name?: string | null;
/** Identifier for app, exposed in Liquid and product JSON. */
appId?: string | null;
/** Merchant facing label of the selling plan group. */
merchantCode?: string | null;
/** Merchant facing description of the selling plan group. */
description?: string | null;
/** List of selling plans to create. */
sellingPlansToCreate?: ValueTypes['SellingPlanInput'][];
/** List of selling plans to update. */
sellingPlansToUpdate?: ValueTypes['SellingPlanInput'][];
/** List of selling plans ids to delete. */
sellingPlansToDelete?: string[];
/** The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */
options?: string[];
/** Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one. */
position?: number | null;
};
/** Return type for `sellingPlanGroupRemoveProductVariants` mutation. */
['SellingPlanGroupRemoveProductVariantsPayload']: AliasType<{
/** The removed product variant ids. */
removedProductVariantIds?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Return type for `sellingPlanGroupRemoveProducts` mutation. */
['SellingPlanGroupRemoveProductsPayload']: AliasType<{
/** The removed product ids. */
removedProductIds?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Specifies resource association with a Selling Plan Group. */
['SellingPlanGroupResourceInput']: {
/** The IDs of the Variants to add to the Selling Plan Group. */
productVariantIds?: string[];
/** The IDs of the Products to add to the Selling Plan Group. */
productIds?: string[];
};
/** The set of valid sort keys for the SellingPlanGroup query. */
['SellingPlanGroupSortKeys']: SellingPlanGroupSortKeys;
/** Return type for `sellingPlanGroupUpdate` mutation. */
['SellingPlanGroupUpdatePayload']: AliasType<{
/** The IDs of the deleted Subscription Plans. */
deletedSellingPlanIds?: boolean;
/** The updated Selling Plan Group. */
sellingPlanGroup?: ValueTypes['SellingPlanGroup'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SellingPlanGroupUserError'];
__typename?: boolean;
}>;
/** Represents a selling plan group custom error. */
['SellingPlanGroupUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `SellingPlanGroupUserError`. */
['SellingPlanGroupUserErrorCode']: SellingPlanGroupUserErrorCode;
/** Specifies the input fields to create or update a selling plan. */
['SellingPlanInput']: {
/** ID of the selling plan. */
id?: string | null;
/** Buyer facing string which describes the selling plan content. */
name?: string | null;
/** Buyer facing string which describes the selling plan commitment. */
description?: string | null;
/** Selling plan policy which describes the billing details. */
billingPolicy?: ValueTypes['SellingPlanBillingPolicyInput'] | null;
/** A selling plan policy which describes the delivery details. */
deliveryPolicy?: ValueTypes['SellingPlanDeliveryPolicyInput'] | null;
/** The pricing policies which describe the pricing details. Each selling plan
can only contain a maximum of 2 pricing policies. */
pricingPolicies?: ValueTypes['SellingPlanPricingPolicyInput'][];
/** The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */
options?: string[];
/** Relative value for display purposes of this plan. A lower position will be displayed before a higher one. */
position?: number | null;
};
/** Represents valid selling plan interval. */
['SellingPlanInterval']: SellingPlanInterval;
/** Represents the type of pricing associated to the selling plan (for example, a $10 or 20% discount that is set
for a limited period or that is fixed for the duration of the subscription). Selling plan pricing policies and
associated records (selling plan groups, selling plans, billing policy, and delivery policy) are deleted 48
hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need
to restore them later. */
['SellingPlanPricingPolicy']: AliasType<{
['...on SellingPlanFixedPricingPolicy']: ValueTypes['SellingPlanFixedPricingPolicy'];
['...on SellingPlanRecurringPricingPolicy']: ValueTypes['SellingPlanRecurringPricingPolicy'];
__typename?: boolean;
}>;
/** Represents a selling plan pricing policy adjustment type. */
['SellingPlanPricingPolicyAdjustmentType']: SellingPlanPricingPolicyAdjustmentType;
/** Represents a selling plan pricing policy adjustment value type. */
['SellingPlanPricingPolicyAdjustmentValue']: AliasType<{
['...on MoneyV2']: ValueTypes['MoneyV2'];
['...on SellingPlanPricingPolicyPercentageValue']: ValueTypes['SellingPlanPricingPolicyPercentageValue'];
__typename?: boolean;
}>;
/** Represents selling plan pricing policy common fields. */
['SellingPlanPricingPolicyBase']: AliasType<{
/** The price adjustment type. */
adjustmentType?: boolean;
/** The price adjustment value. */
adjustmentValue?: ValueTypes['SellingPlanPricingPolicyAdjustmentValue'];
['...on SellingPlanFixedPricingPolicy']?: Omit<ValueTypes['SellingPlanFixedPricingPolicy'], keyof ValueTypes['SellingPlanPricingPolicyBase']>;
['...on SellingPlanRecurringPricingPolicy']?: Omit<
ValueTypes['SellingPlanRecurringPricingPolicy'],
keyof ValueTypes['SellingPlanPricingPolicyBase']
>;
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a selling plan pricing policy. */
['SellingPlanPricingPolicyInput']: {
/** Recurring pricing policy details. */
recurring?: ValueTypes['SellingPlanRecurringPricingPolicyInput'] | null;
/** Fixed pricing policy details. */
fixed?: ValueTypes['SellingPlanFixedPricingPolicyInput'] | null;
};
/** Represents the percentage value of a selling plan pricing policy percentage type. */
['SellingPlanPricingPolicyPercentageValue']: AliasType<{
/** The percentage value. */
percentage?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a pricing policy adjustment value. */
['SellingPlanPricingPolicyValueInput']: {
/** Defines percentage value. */
percentage?: number | null;
/** Defines fixed value for an fixed amount off or a new policy price. */
fixedValue?: ValueTypes['Decimal'] | null;
};
/** Represents a recurring selling plan billing policy. */
['SellingPlanRecurringBillingPolicy']: AliasType<{
/** Specific anchor dates upon which the billing interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchor'];
/** The date and time when the selling plan billing policy was created. */
createdAt?: boolean;
/** The billing frequency, it can be either: day, week, month or year. */
interval?: boolean;
/** The number of intervals between billings. */
intervalCount?: boolean;
/** Maximum number of billing iterations. */
maxCycles?: boolean;
/** Minimum number of billing iterations. */
minCycles?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a recurring billing policy. */
['SellingPlanRecurringBillingPolicyInput']: {
/** The billing frequency, it can be either: day, week, month or year. */
interval?: ValueTypes['SellingPlanInterval'] | null;
/** The number of intervals between billings. */
intervalCount?: number | null;
/** Specific anchor dates upon which the billing interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchorInput'][];
/** Minimum number of billing iterations. */
minCycles?: number | null;
/** Maximum number of billing iterations. */
maxCycles?: number | null;
};
/** Represents a recurring selling plan delivery policy. */
['SellingPlanRecurringDeliveryPolicy']: AliasType<{
/** Specific anchor dates upon which the delivery interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchor'];
/** The date and time when the selling plan delivery policy was created. */
createdAt?: boolean;
/** A buffer period for orders to be included in a cycle. */
cutoff?: boolean;
/** Specifies if the delivery policy is merchant or buyer-centric.
Buyer-centric delivery policies state the time when the buyer will receive the goods.
Merchant-centric delivery policies state the time when the fulfillment should be started.
Currently, only merchant-centric delivery policies are supported. */
intent?: boolean;
/** The delivery frequency, it can be either: day, week, month or year. */
interval?: boolean;
/** The number of intervals between deliveries. */
intervalCount?: boolean;
/** Fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`. */
preAnchorBehavior?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields to create or update a recurring delivery policy. */
['SellingPlanRecurringDeliveryPolicyInput']: {
/** The delivery frequency, it can be either: day, week, month or year. */
interval?: ValueTypes['SellingPlanInterval'] | null;
/** The number of intervals between deliveries. */
intervalCount?: number | null;
/** Specific anchor dates upon which the delivery interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchorInput'][];
/** A buffer period for orders to be included in a cycle. */
cutoff?: number | null;
/** Intention of this delivery policy, it can be either: delivery or fulfillment. */
intent?: ValueTypes['SellingPlanRecurringDeliveryPolicyIntent'] | null;
/** The pre anchor behavior. It can be either: asap or next. */
preAnchorBehavior?: ValueTypes['SellingPlanRecurringDeliveryPolicyPreAnchorBehavior'] | null;
};
/** Possible intentions of a Delivery Policy. */
['SellingPlanRecurringDeliveryPolicyIntent']: SellingPlanRecurringDeliveryPolicyIntent;
/** Possible fulfillment or delivery behaviors of the first fulfillment when the orderis placed before the anchor. */
['SellingPlanRecurringDeliveryPolicyPreAnchorBehavior']: SellingPlanRecurringDeliveryPolicyPreAnchorBehavior;
/** Represents a recurring selling plan pricing policy. */
['SellingPlanRecurringPricingPolicy']: AliasType<{
/** The price adjustment type. */
adjustmentType?: boolean;
/** The price adjustment value. */
adjustmentValue?: ValueTypes['SellingPlanPricingPolicyAdjustmentValue'];
/** Cycle after which this pricing policy applies. */
afterCycle?: boolean;
/** The date and time when the recurring selling plan pricing policy was created. */
createdAt?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields required to create or update a recurring selling plan pricing policy. */
['SellingPlanRecurringPricingPolicyInput']: {
/** ID of the pricing policy. */
id?: string | null;
/** Price adjustment type defined by the policy. */
adjustmentType?: ValueTypes['SellingPlanPricingPolicyAdjustmentType'] | null;
/** Price adjustment value defined by the policy. */
adjustmentValue?: ValueTypes['SellingPlanPricingPolicyValueInput'] | null;
/** Cycle after which the pricing policy applies. */
afterCycle: number;
};
/** Represents the shipping details that the customer chose for their order. */
['ShippingLine']: AliasType<{
/** A reference to the carrier service that provided the rate.
Present when the rate was computed by a third-party carrier service. */
carrierIdentifier?: boolean;
/** A reference to the shipping method. */
code?: boolean;
/** Whether the shipping line is custom or not. */
custom?: boolean;
/** The general classification of the delivery method. */
deliveryCategory?: boolean;
/** The discounts that have been allocated to the shipping line. */
discountAllocations?: ValueTypes['DiscountAllocation'];
/** The pre-tax shipping price with discounts applied. */
discountedPrice?: ValueTypes['MoneyV2'];
/** The pre-tax shipping price with discounts applied. */
discountedPriceSet?: ValueTypes['MoneyBag'];
/** A globally-unique identifier. */
id?: boolean;
/** The pre-tax shipping price without any discounts applied. */
originalPrice?: ValueTypes['MoneyV2'];
/** The pre-tax shipping price without any discounts applied. */
originalPriceSet?: ValueTypes['MoneyBag'];
/** The phone number at the shipping address. */
phone?: boolean;
/** Returns the price of the shipping line. */
price?: boolean;
/** The fulfillment service requested for the shipping method.
Present if the shipping method requires processing by a third party fulfillment service. */
requestedFulfillmentService?: ValueTypes['FulfillmentService'];
/** A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users. */
shippingRateHandle?: boolean;
/** Returns the rate source for the shipping line. */
source?: boolean;
/** The TaxLine objects connected to this shipping line. */
taxLines?: ValueTypes['TaxLine'];
/** Returns the title of the shipping line. */
title?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ShippingLines. */
['ShippingLineConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ShippingLineEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ShippingLine and a cursor during pagination. */
['ShippingLineEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ShippingLineEdge. */
node?: ValueTypes['ShippingLine'];
__typename?: boolean;
}>;
/** Specifies the shipping details for the order. */
['ShippingLineInput']: {
/** Price of the shipping rate. */
price?: ValueTypes['Money'] | null;
/** A unique identifier for the shipping rate. */
shippingRateHandle?: string | null;
/** Title of the shipping rate. */
title?: string | null;
};
/** A sale associated with a shipping charge. */
['ShippingLineSale']: AliasType<{
/** The type of order action that the sale represents. */
actionType?: boolean;
/** The unique identifier for the sale. */
id?: boolean;
/** The line type assocated with the sale. */
lineType?: boolean;
/** The number of units either ordered or intended to be returned. */
quantity?: boolean;
/** The shipping line item for the associated sale. `shippingLine` is not available if the `SaleActionType` is a return. */
shippingLine?: ValueTypes['ShippingLine'];
/** All individual taxes associated with the sale. */
taxes?: ValueTypes['SaleTax'];
/** The total sale amount after taxes and discounts. */
totalAmount?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale after taxes. */
totalDiscountAmountAfterTaxes?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale before taxes. */
totalDiscountAmountBeforeTaxes?: ValueTypes['MoneyBag'];
/** The total amount of taxes for the sale. */
totalTaxAmount?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** The shipping method for the delivery. Customers will see applicable shipping methods in the shipping section of checkout. */
['ShippingMethod']: AliasType<{
/** A unique code associated with the rate. For example: `expedited_mail` */
code?: boolean;
/** A description of the rate, which customers will see at checkout.
For example: `Local delivery`, `Free Express Worldwide`, `Includes tracking and insurance`. */
label?: boolean;
__typename?: boolean;
}>;
/** Return type for `shippingPackageDelete` mutation. */
['ShippingPackageDeletePayload']: AliasType<{
/** The ID of the deleted shipping package. */
deletedId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `shippingPackageMakeDefault` mutation. */
['ShippingPackageMakeDefaultPayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `shippingPackageUpdate` mutation. */
['ShippingPackageUpdatePayload']: AliasType<{
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** A shipping rate is an additional cost added to the cost of the products that were ordered. */
['ShippingRate']: AliasType<{
/** Human-readable unique identifier for this shipping rate. */
handle?: boolean;
/** The cost associated with the shipping rate. */
price?: ValueTypes['MoneyV2'];
/** The name of the shipping rate. */
title?: boolean;
__typename?: boolean;
}>;
/** Represents the shipping costs refunded on the Refund. */
['ShippingRefund']: AliasType<{
/** The monetary value of the shipping fees to be refunded. */
amount?: boolean;
/** The monetary value of the shipping fees to be refunded in shop and presentment currencies. */
amountSet?: ValueTypes['MoneyBag'];
/** The maximum amount of shipping fees currently refundable. */
maximumRefundable?: boolean;
/** The maximum amount of shipping fees currently refundable in shop and presentment currencies. */
maximumRefundableSet?: ValueTypes['MoneyBag'];
/** The monetary value of the tax allocated to shipping fees to be refunded. */
tax?: boolean;
/** The monetary value of the tax allocated to shipping fees to be refunded in shop and presentment currencies. */
taxSet?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** The input fields that are required to reimburse shipping costs. */
['ShippingRefundInput']: {
/** The monetary value of the shipping fees to be reimbursed. */
amount?: ValueTypes['Money'] | null;
/** Whether a full refund is provided. */
fullRefund?: boolean | null;
};
/** Represents a collection of the general settings and information about the shop. */
['Shop']: AliasType<{
/** A list of the shop's active alert messages that appear in the Shopify admin. */
alerts?: ValueTypes['ShopAlert'];
/** The token required to query the shop's reports or dashboards. */
analyticsToken?: boolean;
assignedFulfillmentOrders?: [
{
/** The assigment status of the fulfillment orders that should be returned. */
assignmentStatus?:
| ValueTypes['FulfillmentOrderAssignmentStatus']
| null /** Returns fulfillment orders only for certain locations, specified by a list of location IDs. */;
locationIds?: string[] /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['FulfillmentOrderSortKeys'] | null;
},
ValueTypes['FulfillmentOrderConnection']
];
availableChannelApps?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['AppConnection']
];
/** The shop's billing address information. */
billingAddress?: ValueTypes['MailingAddress'];
/** Exposes the number of channels. */
channelCount?: boolean;
channels?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ChannelConnection']
];
/** Specifies whether the shop supports checkouts via Checkout API. */
checkoutApiSupported?: boolean;
collectionByHandle?: [
{
/** The handle of the collection. */
handle: string;
},
ValueTypes['Collection']
];
collectionSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
collections?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CollectionSortKeys'] | null /** Supported filter parameters:
- `collection_type`
- `publishable_status`
- `published_status`
- `title`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['CollectionConnection']
];
/** The public-facing contact email address for the shop.
Customers will use this email to communicate with the shop owner. */
contactEmail?: boolean;
/** Countries that have been defined in shipping zones for the shop. */
countriesInShippingZones?: ValueTypes['CountriesInShippingZones'];
/** The three letter code for the shop's currency. */
currencyCode?: boolean;
/** How currencies are displayed on your store. */
currencyFormats?: ValueTypes['CurrencyFormats'];
currencySettings?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['CurrencySettingConnection']
];
/** Whether customer accounts are required, optional, or disabled for the shop. */
customerAccounts?: boolean;
customerSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CustomerSavedSearchSortKeys'] | null /** Supported filter parameters:
- `name`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['SavedSearchConnection']
];
customerTags?: [
{
/** Returns up to the first `n` elements from the list. */
first: number;
},
ValueTypes['StringConnection']
];
customers?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['CustomerSortKeys'] | null /** Supported filter parameters:
- `accepts_marketing`
- `country`
- `customer_date`
- `email`
- `last_abandoned_order_date`
- `order_date`
- `orders_count`
- `phone`
- `state`
- `tag`
- `tag_not`
- `total_spent`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['CustomerConnection']
];
/** The shop's meta description used in search engine results. */
description?: boolean;
/** The domains configured for the shop. */
domains?: ValueTypes['Domain'];
draftOrderSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
draftOrderTags?: [
{
/** Returns up to the first `n` elements from the list. */
first: number;
},
ValueTypes['StringConnection']
];
draftOrders?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['DraftOrderSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `customer_id`
- `status`
- `tag`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['DraftOrderConnection']
];
/** The shop owner's email address.
Shopify will use this email address to communicate with the shop owner. */
email?: boolean;
/** The presentment currencies enabled for the shop. */
enabledPresentmentCurrencies?: boolean;
/** The set of features enabled for the shop. */
features?: ValueTypes['ShopFeatures'];
fulfillmentOrders?: [
{
/** Whether to include closed fulfillment orders. */
includeClosed?: boolean | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['FulfillmentOrderSortKeys'] | null /** Supported filter parameters:
- `assigned_location_id`
- `status`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['FulfillmentOrderConnection']
];
/** List of the shop's installed fulfillment services. */
fulfillmentServices?: ValueTypes['FulfillmentService'];
/** The shop's time zone as defined by the IANA. */
ianaTimezone?: boolean;
/** A globally-unique identifier. */
id?: boolean;
inventoryItems?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `created_at`
- `id`
- `sku`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['InventoryItemConnection']
];
/** The number of pendings orders on the shop.
Limited to a maximum of 10000. */
limitedPendingOrderCount?: ValueTypes['LimitedPendingOrderCount'];
locations?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['LocationSortKeys'] | null /** Supported filter parameters:
- `active`
- `address1`
- `address2`
- `city`
- `country`
- `legacy`
- `name`
- `province`
- `zip`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** If true, also include the legacy locations of fulfillment services. */;
includeLegacy?: boolean | null /** If true, also include the locations that are deactivated. */;
includeInactive?: boolean | null;
},
ValueTypes['LocationConnection']
];
marketingEvents?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['MarketingEventSortKeys'] | null /** Supported filter parameters:
- `app_id`
- `description`
- `started_at`
- `type`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['MarketingEventConnection']
];
/** The approval signals for a shop to support onboarding to channel apps. */
merchantApprovalSignals?: ValueTypes['MerchantApprovalSignals'];
metafield?: [
{
/** The namespace for the metafield. */
namespace: string /** The key for the metafield. */;
key: string;
},
ValueTypes['Metafield']
];
metafields?: [
{
/** The metafield namespace to filter by. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['MetafieldConnection']
];
/** The shop's .myshopify.com domain name. */
myshopifyDomain?: boolean;
/** The shop's name. */
name?: boolean;
/** The shop's settings related to navigation. */
navigationSettings?: ValueTypes['NavigationItem'];
/** The prefix that appears before order numbers. */
orderNumberFormatPrefix?: boolean;
/** The suffix that appears after order numbers. */
orderNumberFormatSuffix?: boolean;
orderSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
orderTags?: [
{
/** Returns up to the first `n` elements from the list. */
first: number /** Sort type. */;
sort?: ValueTypes['ShopTagSort'] | null;
},
ValueTypes['StringConnection']
];
orders?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['OrderSortKeys'] | null /** Supported filter parameters:
- `cart_token`
- `channel`
- `channel_id`
- `chargeback_status`
- `checkout_token`
- `created_at`
- `credit_card_last4`
- `customer_id`
- `delivery_method`
- `discount_code`
- `earliest_fulfill_by`
- `email`
- `financial_status`
- `fraud_protection_level`
- `fulfillment_location_id`
- `fulfillment_status`
- `gateway`
- `location_id`
- `name`
- `payment_provider_id`
- `processed_at`
- `reference_location_id`
- `return_status`
- `risk_level`
- `sales_channel`
- `source_identifier`
- `source_name`
- `status`
- `tag`
- `tag_not`
- `test`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['OrderConnection']
];
/** The shop's settings related to payments. */
paymentSettings?: ValueTypes['PaymentSettings'];
/** Number of pending orders on the shop. */
pendingOrderCount?: boolean;
/** The shop's billing plan. */
plan?: ValueTypes['ShopPlan'];
priceRuleSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
priceRules?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['PriceRuleSortKeys'] | null /** Supported filter parameters:
- `created_at`
- `discount_type`
- `ends_at`
- `starts_at`
- `status`
- `times_used`
- `updated_at`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['PriceRuleConnection']
];
/** The shop's primary domain name. */
primaryDomain?: ValueTypes['Domain'];
privateMetafield?: [
{
/** The namespace for the private metafield. */
namespace: string /** The key for the private metafield. */;
key: string;
},
ValueTypes['PrivateMetafield']
];
privateMetafields?: [
{
/** Filter the private metafields by namespace. */
namespace?: string | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['PrivateMetafieldConnection']
];
productByHandle?: [
{
/** The handle of the product. */
handle: string;
},
ValueTypes['Product']
];
productImages?: [
{
/** Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. */
maxWidth?:
| number
| null /** Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. */;
maxHeight?:
| number
| null /** Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. */;
crop?:
| ValueTypes['CropRegion']
| null /** Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. */;
scale?: number | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductImageSortKeys'] | null;
},
ValueTypes['ImageConnection']
];
productSavedSearches?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SavedSearchConnection']
];
productTags?: [
{
/** Returns up to the first `n` elements from the list. */
first: number;
},
ValueTypes['StringConnection']
];
productTypes?: [
{
/** Returns up to the first `n` elements from the list. */
first: number;
},
ValueTypes['StringConnection']
];
productVariants?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductVariantSortKeys'] | null /** Supported filter parameters:
- `barcode`
- `collection`
- `delivery_profile_id`
- `exclude_composite`
- `gift_card`
- `inventory_quantity`
- `location_id`
- `managed`
- `managed_by`
- `product_id`
- `product_status`
- `product_type`
- `publishable_status`
- `published_status`
- `sku`
- `tag`
- `tag_not`
- `taxable`
- `title`
- `updated_at`
- `vendor`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['ProductVariantConnection']
];
productVendors?: [
{
/** Returns up to the first `n` elements from the list. */
first: number;
},
ValueTypes['StringConnection']
];
products?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Sort the underlying list by the given key. */;
sortKey?: ValueTypes['ProductSortKeys'] | null /** Supported filter parameters:
- `barcode`
- `created_at`
- `delivery_profile_id`
- `error_feedback`
- `gift_card`
- `has_only_composites`
- `has_only_default_variant`
- `id`
- `inventory_total`
- `is_price_reduced`
- `out_of_stock_somewhere`
- `price`
- `product_type`
- `publishable_status`
- `published_status`
- `sku`
- `status`
- `tag`
- `tag_not`
- `title`
- `updated_at`
- `vendor`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null /** The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch). */;
savedSearchId?: string | null;
},
ValueTypes['ProductConnection']
];
/** The number of publications for the shop. */
publicationCount?: boolean;
/** The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed. */
resourceLimits?: ValueTypes['ShopResourceLimits'];
/** The URL of the rich text editor that can be used for mobile devices. */
richTextEditorUrl?: boolean;
search?: [
{
/** The search query to filter by. */
query: string /** The search result types to filter by. */;
types?: ValueTypes['SearchResultType'][] /** Returns up to the first `n` elements from the list. */;
first: number /** Returns the elements that come after the specified cursor. */;
after?: string | null;
},
ValueTypes['SearchResultConnection']
];
/** The list of search filter options for the shop. These can be used to filter productvisibility for the shop. */
searchFilters?: ValueTypes['SearchFilterOptions'];
/** Whether the shop has outstanding setup steps. */
setupRequired?: boolean;
/** The list of countries that the shop ships to. */
shipsToCountries?: boolean;
/** The list of all legal policies associated with a shop. */
shopPolicies?: ValueTypes['ShopPolicy'];
/** Shopify Payments account information, including balances and payouts. */
shopifyPaymentsAccount?: ValueTypes['ShopifyPaymentsAccount'];
storefrontAccessTokens?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['StorefrontAccessTokenConnection']
];
/** The URL of the shop's storefront. */
storefrontUrl?: boolean;
/** Whether the shop charges taxes for shipping. */
taxShipping?: boolean;
/** Whether applicable taxes are included in the shop's product prices. */
taxesIncluded?: boolean;
/** The shop's time zone abbreviation. */
timezoneAbbreviation?: boolean;
/** The shop's time zone offset. */
timezoneOffset?: boolean;
/** The shop's time zone offset expressed as a number of minutes. */
timezoneOffsetMinutes?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
/** The shop's unit system for weights and measures. */
unitSystem?: boolean;
uploadedImagesByIds?: [
{
/** The IDs of the uploaded images. */
imageIds: string[];
},
ValueTypes['Image']
];
/** The URL of the shop's online store. */
url?: boolean;
/** The shop's primary unit of weight for products and shipping. */
weightUnit?: boolean;
__typename?: boolean;
}>;
/** An alert message that appears in the Shopify admin about a problem with a store setting, with an action to take. For example, you could show an alert to ask the merchant to enter their billing information to activate Shopify Plus. */
['ShopAlert']: AliasType<{
/** The text for the button in the alert that links to related information. For example, _Add credit card_. */
action?: ValueTypes['ShopAlertAction'];
/** A description of the alert and further information, such as whether the merchant will be charged. */
description?: boolean;
__typename?: boolean;
}>;
/** An action associated to a shop alert, such as adding a credit card. */
['ShopAlertAction']: AliasType<{
/** The text for the button in the alert. For example, _Add credit card_. */
title?: boolean;
/** The target URL that the button links to. */
url?: boolean;
__typename?: boolean;
}>;
/** Possible branding of a shop.
Branding can be used to define the look of a shop including its styling and logo in the Shopify Admin. */
['ShopBranding']: ShopBranding;
/** Represents the shop's customer account requirement preference. */
['ShopCustomerAccountsSetting']: ShopCustomerAccountsSetting;
/** Represents the feature set available to the shop.
Most fields specify whether a feature is enabled for a shop, and some fields return information
related to specific features. */
['ShopFeatures']: AliasType<{
/** Whether a shop has access to Avalara AvaTax. */
avalaraAvatax?: boolean;
/** The branding of the shop, which influences its look and feel in the Shopify admin. */
branding?: boolean;
/** Whether a shop's online store can have CAPTCHA protection. */
captcha?: boolean;
/** Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify. */
captchaExternalDomains?: boolean;
/** Whether the delivery profiles functionality is enabled for this shop. */
deliveryProfiles?: boolean;
/** Whether a shop has access to the Google Analytics dynamic remarketing feature. */
dynamicRemarketing?: boolean;
/** Whether a shop can be migrated to use Shopify subscriptions. */
eligibleForSubscriptionMigration?: boolean;
/** Whether a shop is configured properly to sell subscriptions. */
eligibleForSubscriptions?: boolean;
/** Whether a shop can create gift cards. */
giftCards?: boolean;
/** Whether a shop displays Harmonized System codes on products. This is used for customs when shipping
internationally. */
harmonizedSystemCode?: boolean;
/** Whether a shop can enable international domains. */
internationalDomains?: boolean;
/** Whether a shop can enable international price overrides. */
internationalPriceOverrides?: boolean;
/** Whether a shop can enable international price rules. */
internationalPriceRules?: boolean;
/** Whether a shop has enabled a legacy subscription gateway to handle older subscriptions. */
legacySubscriptionGatewayEnabled?: boolean;
/** Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial
or don't have a storefront. */
liveView?: boolean;
/** Whether a shop has multi-location functionality. */
multiLocation?: boolean;
/** Whether a shop has access to the onboarding visual. */
onboardingVisual?: boolean;
/** Whether a shop is configured to sell subscriptions with PayPal Express. */
paypalExpressSubscriptionGatewayStatus?: boolean;
/** Whether a shop has access to all reporting features. */
reports?: boolean;
/** Whether a shop has ever had subscription products. */
sellsSubscriptions?: boolean;
/** Whether the shop has a Shopify Plus subscription. */
shopifyPlus?: boolean;
/** Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful. */
showMetrics?: boolean;
/** Whether a shop has an online store. */
storefront?: boolean;
/** Whether a shop is using Shopify Balance. */
usingShopifyBalance?: boolean;
__typename?: boolean;
}>;
/** Locale that has been enabled on a shop. */
['ShopLocale']: AliasType<{
/** Locale ISO code. */
locale?: boolean;
/** Human-readable locale name. */
name?: boolean;
/** Whether or not this is the default locale for the shop. */
primary?: boolean;
/** Whether or not the locale is visible to buyers. */
published?: boolean;
__typename?: boolean;
}>;
/** Return type for `shopLocaleDisable` mutation. */
['ShopLocaleDisablePayload']: AliasType<{
/** ISO code of the locale that was deleted. */
locale?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `shopLocaleEnable` mutation. */
['ShopLocaleEnablePayload']: AliasType<{
/** ISO code of the locale that was enabled. */
shopLocale?: ValueTypes['ShopLocale'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the input fields for a shop locale. */
['ShopLocaleInput']: {
/** Specifies the published state of the locale. Only published locales are visible to the buyer. */
published?: boolean | null;
};
/** Return type for `shopLocaleUpdate` mutation. */
['ShopLocaleUpdatePayload']: AliasType<{
/** The locale that was updated. */
shopLocale?: ValueTypes['ShopLocale'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Represents the billing plan of the shop. */
['ShopPlan']: AliasType<{
/** The name of the shop's billing plan. */
displayName?: boolean;
/** Whether the shop is a partner development shop for testing purposes. */
partnerDevelopment?: boolean;
/** Whether the shop has a Shopify Plus subscription. */
shopifyPlus?: boolean;
__typename?: boolean;
}>;
/** Policy that a merchant has configured for their store, such as their refund or privacy policy. */
['ShopPolicy']: AliasType<{
/** The text of the policy. The maximum size is 512kb. */
body?: boolean;
/** A globally-unique identifier. */
id?: boolean;
translations?: [
{
/** Filters translations locale. */
locale: string;
},
ValueTypes['PublishedTranslation']
];
/** The shop policy type. */
type?: boolean;
/** The public URL of the policy. */
url?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `ShopPolicyUserError`. */
['ShopPolicyErrorCode']: ShopPolicyErrorCode;
/** Specifies the input fields required to update a policy. */
['ShopPolicyInput']: {
/** The shop policy type. */
type: ValueTypes['ShopPolicyType'];
/** Policy text, maximum size of 512kb. */
body: string;
};
/** Available shop policy types. */
['ShopPolicyType']: ShopPolicyType;
/** Return type for `shopPolicyUpdate` mutation. */
['ShopPolicyUpdatePayload']: AliasType<{
/** The shop policy that has been updated. */
shopPolicy?: ValueTypes['ShopPolicy'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['ShopPolicyUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of a shop policy mutation. */
['ShopPolicyUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Resource limits of a shop. */
['ShopResourceLimits']: AliasType<{
/** Maximum number of locations allowed. */
locationLimit?: boolean;
/** Maximum number of product options allowed. */
maxProductOptions?: boolean;
/** The maximum number of variants allowed per product. */
maxProductVariants?: boolean;
/** Whether the shop has reached the limit of the number of URL redirects it can make for resources. */
redirectLimitReached?: boolean;
/** The maximum number of variants allowed per shop. If the shop has unlimited SKUs, then the quantity used cannot be retrieved. */
skuResourceLimits?: ValueTypes['ResourceLimit'];
__typename?: boolean;
}>;
/** Possible sort of tags. */
['ShopTagSort']: ShopTagSort;
/** Balance and payout information for a
[Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments)
account. Balance includes all balances for the currencies supported by the shop.
You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. */
['ShopifyPaymentsAccount']: AliasType<{
/** Whether the Shopify Payments setup is completed. */
activated?: boolean;
/** Current balances in all currencies for the account. */
balance?: ValueTypes['MoneyV2'];
bankAccounts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ShopifyPaymentsBankAccountConnection']
];
/** Statement descriptor used for charges.
This is what buyers will see on their credit card or bank statements when making a purchase. */
chargeStatementDescriptor?: boolean;
/** Statement descriptors used for charges.
This is what buyers will see on their credit card or bank statements when making a purchase. */
chargeStatementDescriptors?: ValueTypes['ShopifyPaymentsChargeStatementDescriptor'];
/** The Shopify Payments account country. */
country?: boolean;
/** The default payout currency for the Shopify Payments account. */
defaultCurrency?: boolean;
disputes?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null /** Supported filter parameters:
- `id`
- `initiated_at`
- `status`
See the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)
for more information about using filters. */;
query?: string | null;
},
ValueTypes['ShopifyPaymentsDisputeConnection']
];
/** The fraud settings of the Shopify Payments account. */
fraudSettings?: ValueTypes['ShopifyPaymentsFraudSettings'];
/** A globally-unique identifier. */
id?: boolean;
/** The notifications settings for the account. */
notificationSettings?: ValueTypes['ShopifyPaymentsNotificationSettings'];
/** Whether the Shopify Payments account can be onboarded. */
onboardable?: boolean;
/** Payout schedule for the account. */
payoutSchedule?: ValueTypes['ShopifyPaymentsPayoutSchedule'];
/** Descriptor used for payouts.
This is what merchants will see on their bank statement when receiving a payout. */
payoutStatementDescriptor?: boolean;
payouts?: [
{
/** Filter the direction of the payout. */
transactionType?: ValueTypes['ShopifyPaymentsPayoutTransactionType'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ShopifyPaymentsPayoutConnection']
];
/** The permitted documents for identity verification. */
permittedVerificationDocuments?: ValueTypes['ShopifyPaymentsVerificationDocument'];
/** The verifications necessary for this account. */
verifications?: ValueTypes['ShopifyPaymentsVerification'];
__typename?: boolean;
}>;
/** A bank account that can receive payouts. */
['ShopifyPaymentsBankAccount']: AliasType<{
/** The account number of the bank account. */
accountNumber?: boolean;
/** The last digits of the account number (the rest is redacted). */
accountNumberLastDigits?: boolean;
/** The name of the bank. */
bankName?: boolean;
/** The country of the bank. */
country?: boolean;
/** The date that the bank account was created. */
createdAt?: boolean;
/** The currency of the bank account. */
currency?: boolean;
/** A globally-unique identifier. */
id?: boolean;
payouts?: [
{
/** Filter the direction of the payout. */
transactionType?: ValueTypes['ShopifyPaymentsPayoutTransactionType'] | null /** Returns up to the first `n` elements from the list. */;
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['ShopifyPaymentsPayoutConnection']
];
/** The routing number of the bank account. */
routingNumber?: boolean;
/** The status of the bank account. */
status?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ShopifyPaymentsBankAccounts. */
['ShopifyPaymentsBankAccountConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ShopifyPaymentsBankAccountEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ShopifyPaymentsBankAccount and a cursor during pagination. */
['ShopifyPaymentsBankAccountEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ShopifyPaymentsBankAccountEdge. */
node?: ValueTypes['ShopifyPaymentsBankAccount'];
__typename?: boolean;
}>;
/** The bank account status. */
['ShopifyPaymentsBankAccountStatus']: ShopifyPaymentsBankAccountStatus;
/** The charge descriptors for a payments account. */
['ShopifyPaymentsChargeStatementDescriptor']: AliasType<{
/** The default charge statement descriptor. */
default?: boolean;
/** The prefix of the statement descriptor. */
prefix?: boolean;
['...on ShopifyPaymentsDefaultChargeStatementDescriptor']?: Omit<
ValueTypes['ShopifyPaymentsDefaultChargeStatementDescriptor'],
keyof ValueTypes['ShopifyPaymentsChargeStatementDescriptor']
>;
['...on ShopifyPaymentsJpChargeStatementDescriptor']?: Omit<
ValueTypes['ShopifyPaymentsJpChargeStatementDescriptor'],
keyof ValueTypes['ShopifyPaymentsChargeStatementDescriptor']
>;
__typename?: boolean;
}>;
/** The charge descriptors for a payments account. */
['ShopifyPaymentsDefaultChargeStatementDescriptor']: AliasType<{
/** The default charge statement descriptor. */
default?: boolean;
/** The prefix of the statement descriptor. */
prefix?: boolean;
__typename?: boolean;
}>;
/** A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution. */
['ShopifyPaymentsDispute']: AliasType<{
/** The total amount disputed by the cardholder. */
amount?: ValueTypes['MoneyV2'];
/** The deadline for evidence submission. */
evidenceDueBy?: boolean;
/** The date when evidence was sent. Returns null if evidence has not yet been sent. */
evidenceSentOn?: boolean;
/** The date when this dispute was resolved. Returns null if the dispute is not yet resolved. */
finalizedOn?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The date when this dispute was initiated. */
initiatedAt?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The order that contains the charge that is under dispute. */
order?: ValueTypes['Order'];
/** The reason of the dispute. */
reasonDetails?: ValueTypes['ShopifyPaymentsDisputeReasonDetails'];
/** The current state of the dispute. */
status?: boolean;
/** Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. */
type?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ShopifyPaymentsDisputes. */
['ShopifyPaymentsDisputeConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ShopifyPaymentsDisputeEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination. */
['ShopifyPaymentsDisputeEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ShopifyPaymentsDisputeEdge. */
node?: ValueTypes['ShopifyPaymentsDispute'];
__typename?: boolean;
}>;
/** The reason for the dispute provided by the cardholder's bank. */
['ShopifyPaymentsDisputeReason']: ShopifyPaymentsDisputeReason;
/** Details regarding a dispute reason. */
['ShopifyPaymentsDisputeReasonDetails']: AliasType<{
/** The raw code provided by the payment network. */
networkReasonCode?: boolean;
/** The reason for the dispute provided by the cardholder's banks. */
reason?: boolean;
__typename?: boolean;
}>;
/** Presents all Shopify Payments information related to an extended authorization. */
['ShopifyPaymentsExtendedAuthorization']: AliasType<{
/** The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. */
extendedAuthorizationExpiresAt?: boolean;
/** The time after which capture will incur an additional fee. */
standardAuthorizationExpiresAt?: boolean;
__typename?: boolean;
}>;
/** The fraud settings of a payments account. */
['ShopifyPaymentsFraudSettings']: AliasType<{
/** Decline a charge if there is an AVS failure. */
declineChargeOnAvsFailure?: boolean;
/** Decline a charge if there is an CVC failure. */
declineChargeOnCvcFailure?: boolean;
__typename?: boolean;
}>;
/** The charge descriptors for a Japanese payments account. */
['ShopifyPaymentsJpChargeStatementDescriptor']: AliasType<{
/** The default charge statement descriptor. */
default?: boolean;
/** The charge statement descriptor in kana. */
kana?: boolean;
/** The charge statement descriptor in kanji. */
kanji?: boolean;
/** The prefix of the statement descriptor. */
prefix?: boolean;
__typename?: boolean;
}>;
/** The notification settings for the account. */
['ShopifyPaymentsNotificationSettings']: AliasType<{
/** Receive email notifications when new payouts are sent or payouts fail. */
payouts?: boolean;
__typename?: boolean;
}>;
/** Payouts represent the movement of money between a merchant's Shopify
Payments balance and their bank account. */
['ShopifyPaymentsPayout']: AliasType<{
/** The bank account for the payout. */
bankAccount?: ValueTypes['ShopifyPaymentsBankAccount'];
/** The total amount and currency of the payout. */
gross?: ValueTypes['MoneyV2'];
/** A globally-unique identifier. */
id?: boolean;
/** The exact time when the payout was issued. The payout only contains
balance transactions that were available at this time. */
issuedAt?: boolean;
/** The ID of the corresponding resource in the REST Admin API. */
legacyResourceId?: boolean;
/** The total amount and currency of the payout. */
net?: ValueTypes['MoneyV2'];
/** The transfer status of the payout. */
status?: boolean;
/** The summary of the payout. */
summary?: ValueTypes['ShopifyPaymentsPayoutSummary'];
/** The direction of the payout. */
transactionType?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple ShopifyPaymentsPayouts. */
['ShopifyPaymentsPayoutConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['ShopifyPaymentsPayoutEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination. */
['ShopifyPaymentsPayoutEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of ShopifyPaymentsPayoutEdge. */
node?: ValueTypes['ShopifyPaymentsPayout'];
__typename?: boolean;
}>;
/** The interval at which payouts are sent to the connected bank account. */
['ShopifyPaymentsPayoutInterval']: ShopifyPaymentsPayoutInterval;
/** The payment schedule for a payments account. */
['ShopifyPaymentsPayoutSchedule']: AliasType<{
/** The interval at which payouts are sent to the connected bank account. */
interval?: boolean;
/** The day of the month funds will be paid out.
The value can be any day of the month from the 1st to the 31st.
If the payment interval is set to monthly, this value will be used.
Payouts scheduled between 29-31st of the month are sent on the last day of shorter months. */
monthlyAnchor?: boolean;
/** The day of the week funds will be paid out.
The value can be any weekday from Monday to Friday.
If the payment interval is set to weekly, this value will be used. */
weeklyAnchor?: boolean;
__typename?: boolean;
}>;
/** The transfer status of the payout. */
['ShopifyPaymentsPayoutStatus']: ShopifyPaymentsPayoutStatus;
/** Breakdown of the total fees and gross of each of the different types of transactions associated
with the payout. */
['ShopifyPaymentsPayoutSummary']: AliasType<{
/** Total fees for all adjustments including disputes. */
adjustmentsFee?: ValueTypes['MoneyV2'];
/** Total gross amount for all adjustments including disputes. */
adjustmentsGross?: ValueTypes['MoneyV2'];
/** Total fees for all charges. */
chargesFee?: ValueTypes['MoneyV2'];
/** Total gross amount for all charges. */
chargesGross?: ValueTypes['MoneyV2'];
/** Total fees for all refunds. */
refundsFee?: ValueTypes['MoneyV2'];
/** Total gross amount for all refunds. */
refundsFeeGross?: ValueTypes['MoneyV2'];
/** Total fees for all reserved funds. */
reservedFundsFee?: ValueTypes['MoneyV2'];
/** Total gross amount for all reserved funds. */
reservedFundsGross?: ValueTypes['MoneyV2'];
/** Total fees for all retried payouts. */
retriedPayoutsFee?: ValueTypes['MoneyV2'];
/** Total gross amount for all retried payouts. */
retriedPayoutsGross?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** The possible transaction types for a payout. */
['ShopifyPaymentsPayoutTransactionType']: ShopifyPaymentsPayoutTransactionType;
/** Presents all Shopify Payments specific information related to an order refund. */
['ShopifyPaymentsRefundSet']: AliasType<{
/** The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. */
acquirerReferenceNumber?: boolean;
__typename?: boolean;
}>;
/** Presents all Shopify Payments specific information related to an order transaction. */
['ShopifyPaymentsTransactionSet']: AliasType<{
/** Contains all fields related to an extended authorization. */
extendedAuthorizationSet?: ValueTypes['ShopifyPaymentsExtendedAuthorization'];
/** Contains all fields related to a refund. */
refundSet?: ValueTypes['ShopifyPaymentsRefundSet'];
__typename?: boolean;
}>;
/** Each subject (individual) of an account has a verification object giving
information about the verification state. */
['ShopifyPaymentsVerification']: AliasType<{
/** A globally-unique identifier. */
id?: boolean;
/** The status of the verification. */
status?: boolean;
/** The subject/individual who has to be verified. */
subject?: ValueTypes['ShopifyPaymentsVerificationSubject'];
__typename?: boolean;
}>;
/** A document which can be used to verify an individual. */
['ShopifyPaymentsVerificationDocument']: AliasType<{
/** True if the back side of the document is required. */
backRequired?: boolean;
/** True if the front side of the document is required. */
frontRequired?: boolean;
/** The type of the document which can be used for verification. */
type?: boolean;
__typename?: boolean;
}>;
/** The types of possible verification documents. */
['ShopifyPaymentsVerificationDocumentType']: ShopifyPaymentsVerificationDocumentType;
/** The status of a verification. */
['ShopifyPaymentsVerificationStatus']: ShopifyPaymentsVerificationStatus;
/** The verification subject represents an individual that has to be verified. */
['ShopifyPaymentsVerificationSubject']: AliasType<{
/** The family name of the individual to verify. */
familyName?: boolean;
/** The given name of the individual to verify. */
givenName?: boolean;
__typename?: boolean;
}>;
/** Image to be uploaded. */
['StageImageInput']: {
/** Image resource. */
resource: ValueTypes['StagedUploadTargetGenerateUploadResource'];
/** Image filename. */
filename: string;
/** Image MIME type. */
mimeType: string;
/** HTTP method to be used by the Staged Upload. */
httpMethod?: ValueTypes['StagedUploadHttpMethodType'] | null;
};
/** Staged media target information. */
['StagedMediaUploadTarget']: AliasType<{
/** Parameters of the media to be uploaded. */
parameters?: ValueTypes['StagedUploadParameter'];
/** The url to be passed as the original_source for the product create media mutation input. */
resourceUrl?: boolean;
/** Media URL. */
url?: boolean;
__typename?: boolean;
}>;
/** Possible HTTP method of a staged upload target. */
['StagedUploadHttpMethodType']: StagedUploadHttpMethodType;
/** Media to be uploaded. */
['StagedUploadInput']: {
/** Media resource. */
resource: ValueTypes['StagedUploadTargetGenerateUploadResource'];
/** Media filename. */
filename: string;
/** Media MIME type. */
mimeType: string;
/** HTTP method to be used by the Staged Upload. */
httpMethod?: ValueTypes['StagedUploadHttpMethodType'] | null;
/** Size of the file to upload, in bytes. This is required for VIDEO and MODEL_3D resources. */
fileSize?: ValueTypes['UnsignedInt64'] | null;
};
/** Upload parameter of a Media. */
['StagedUploadParameter']: AliasType<{
/** Parameter name. */
name?: boolean;
/** Parameter value. */
value?: boolean;
__typename?: boolean;
}>;
/** Staged target information. */
['StagedUploadTarget']: AliasType<{
/** Parameters of an image to be uploaded. */
parameters?: ValueTypes['ImageUploadParameter'];
/** Image URL. */
url?: boolean;
__typename?: boolean;
}>;
/** Specifies the fields required to generate the URL and parameters needed to upload an asset to Shopify. */
['StagedUploadTargetGenerateInput']: {
/** The resource type being uploaded. */
resource: ValueTypes['StagedUploadTargetGenerateUploadResource'];
/** The filename of the asset being uploaded. */
filename: string;
/** The MIME type of the asset being uploaded. */
mimeType: string;
/** The HTTP method to be used by the staged upload. */
httpMethod?: ValueTypes['StagedUploadHttpMethodType'] | null;
/** The size of the file to upload, in bytes. */
fileSize?: ValueTypes['UnsignedInt64'] | null;
};
/** Return type for `stagedUploadTargetGenerate` mutation. */
['StagedUploadTargetGeneratePayload']: AliasType<{
/** The signed parameters that can be used to upload the asset. */
parameters?: ValueTypes['MutationsStagedUploadTargetGenerateUploadParameter'];
/** The signed URL where the asset can be uploaded. */
url?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** The resource type to receive. */
['StagedUploadTargetGenerateUploadResource']: StagedUploadTargetGenerateUploadResource;
/** Return type for `stagedUploadTargetsGenerate` mutation. */
['StagedUploadTargetsGeneratePayload']: AliasType<{
/** The staged upload targets that were generated. */
urls?: ValueTypes['StagedUploadTarget'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `stagedUploadsCreate` mutation. */
['StagedUploadsCreatePayload']: AliasType<{
/** The staged upload targets that were generated. */
stagedTargets?: ValueTypes['StagedMediaUploadTarget'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `standardMetafieldDefinitionEnable` mutation. */
['StandardMetafieldDefinitionEnablePayload']: AliasType<{
/** The metafield definition that was created. */
createdDefinition?: ValueTypes['MetafieldDefinition'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['StandardMetafieldDefinitionEnableUserError'];
__typename?: boolean;
}>;
/** An error that occurs during the execution of `StandardMetafieldDefinitionEnable`. */
['StandardMetafieldDefinitionEnableUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `StandardMetafieldDefinitionEnableUserError`. */
['StandardMetafieldDefinitionEnableUserErrorCode']: StandardMetafieldDefinitionEnableUserErrorCode;
/** Standard metafield definition templates provide preset configurations to create metafield definitions.
Each template has a specific namespace and key that we've reserved to have specific meanings for common use cases.
Refer to the [list of standard metafield definitions](https://shopify.dev/apps/metafields/definitions/standard-definitions). */
['StandardMetafieldDefinitionTemplate']: AliasType<{
/** The description of the standard metafield definition. */
description?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** The key owned by the definition after the definition has been activated. */
key?: boolean;
/** The human-readable name for the standard metafield definition. */
name?: boolean;
/** The namespace owned by the definition after the definition has been activated. */
namespace?: boolean;
/** The list of resource types that the standard metafield definition can be applied to. */
ownerTypes?: boolean;
/** The associated [metafield definition type](https://shopify.dev/apps/metafields/definitions/types) that the metafield stores. */
type?: ValueTypes['MetafieldDefinitionType'];
/** The configured validations for the standard metafield definition. */
validations?: ValueTypes['MetafieldDefinitionValidation'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple StandardMetafieldDefinitionTemplates. */
['StandardMetafieldDefinitionTemplateConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['StandardMetafieldDefinitionTemplateEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one StandardMetafieldDefinitionTemplate and a cursor during pagination. */
['StandardMetafieldDefinitionTemplateEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of StandardMetafieldDefinitionTemplateEdge. */
node?: ValueTypes['StandardMetafieldDefinitionTemplate'];
__typename?: boolean;
}>;
/** Represents the details of a specific type of product within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt). */
['StandardizedProductType']: AliasType<{
/** The product taxonomy node associated with the standardized product type. */
productTaxonomyNode?: ValueTypes['ProductTaxonomyNode'];
__typename?: boolean;
}>;
/** Provides the fields and values to use when adding a standard product type to a product. The [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) contains the full list of available values. */
['StandardizedProductTypeInput']: {
/** The id of the node in the Shopify taxonomy that represents the product type. */
productTaxonomyNodeId: string;
};
/** Token used to delegate unauthenticated access scopes to clients that need to access the unautheticated Storefront API. */
['StorefrontAccessToken']: AliasType<{
/** List of permissions associated with the token. */
accessScopes?: ValueTypes['AccessScope'];
/** The issued public access token. */
accessToken?: boolean;
/** The date and time when the public access token was created. */
createdAt?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** An arbitrary title for each token determined by the developer, used for reference purposes. */
title?: boolean;
/** The date and time when the storefront access token was updated. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple StorefrontAccessTokens. */
['StorefrontAccessTokenConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['StorefrontAccessTokenEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `storefrontAccessTokenCreate` mutation. */
['StorefrontAccessTokenCreatePayload']: AliasType<{
/** The user's shop. */
shop?: ValueTypes['Shop'];
/** The storefront access token. */
storefrontAccessToken?: ValueTypes['StorefrontAccessToken'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Specifies the input fields to delete a storefront access token. */
['StorefrontAccessTokenDeleteInput']: {
/** The ID of the storefront access token to delete. */
id: string;
};
/** Return type for `storefrontAccessTokenDelete` mutation. */
['StorefrontAccessTokenDeletePayload']: AliasType<{
/** The ID of the deleted storefront access token. */
deletedStorefrontAccessTokenId?: boolean;
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one StorefrontAccessToken and a cursor during pagination. */
['StorefrontAccessTokenEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of StorefrontAccessTokenEdge. */
node?: ValueTypes['StorefrontAccessToken'];
__typename?: boolean;
}>;
/** Specifies the input fields for a storefront access token. */
['StorefrontAccessTokenInput']: {
/** A title for the storefront access token. */
title: string;
};
/** Represents a unique identifier in the Storefront API. A `StorefrontID` value can be used wherever an ID is expected in the Storefront API.
Example value: `"Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzEwMDc5Nzg1MTAw"`. */
['StorefrontID']: unknown;
/** An auto-generated type for paginating through a list of Strings. */
['StringConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['StringEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one String and a cursor during pagination. */
['StringEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of StringEdge. */
node?: boolean;
__typename?: boolean;
}>;
/** Represents an applied code discount. */
['SubscriptionAppliedCodeDiscount']: AliasType<{
/** The unique identifier. */
id?: boolean;
/** The redeem code of the discount that applies on the subscription. */
redeemCode?: boolean;
/** The reason that the discount on the subscription draft is rejected. */
rejectionReason?: boolean;
__typename?: boolean;
}>;
/** A record of an execution of the subscription billing process. Billing attempts use
idempotency keys to avoid duplicate order creation. A successful billing attempt
will create an order. */
['SubscriptionBillingAttempt']: AliasType<{
/** The date and time when the billing attempt was completed. */
completedAt?: boolean;
/** The date and time when the billing attempt was created. */
createdAt?: boolean;
/** A code corresponding to a payment error during processing. */
errorCode?: boolean;
/** A message describing a payment error during processing. */
errorMessage?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** A unique key generated by the client to avoid duplicate payments. */
idempotencyKey?: boolean;
/** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */
nextActionUrl?: boolean;
/** The result of this billing attempt if completed successfully. */
order?: ValueTypes['Order'];
/** Whether or not the billing attempt is still processing. */
ready?: boolean;
/** The subscription contract. */
subscriptionContract?: ValueTypes['SubscriptionContract'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SubscriptionBillingAttempts. */
['SubscriptionBillingAttemptConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SubscriptionBillingAttemptEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Return type for `subscriptionBillingAttemptCreate` mutation. */
['SubscriptionBillingAttemptCreatePayload']: AliasType<{
/** The subscription billing attempt. */
subscriptionBillingAttempt?: ValueTypes['SubscriptionBillingAttempt'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['BillingAttemptUserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination. */
['SubscriptionBillingAttemptEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SubscriptionBillingAttemptEdge. */
node?: ValueTypes['SubscriptionBillingAttempt'];
__typename?: boolean;
}>;
/** The possible error codes associated with making billing attempts. The error codes supplement the
`error_message` to provide consistent results and help with dunning management. */
['SubscriptionBillingAttemptErrorCode']: SubscriptionBillingAttemptErrorCode;
/** Specifies the fields required to complete a subscription billing attempt. */
['SubscriptionBillingAttemptInput']: {
/** A unique key generated by the client to avoid duplicate payments. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */
idempotencyKey: string;
};
/** Represents a Subscription Billing Policy. */
['SubscriptionBillingPolicy']: AliasType<{
/** Specific anchor dates upon which the billing interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchor'];
/** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */
interval?: boolean;
/** The number of billing intervals between invoices. */
intervalCount?: boolean;
/** Maximum amount of cycles after which the subscription ends. */
maxCycles?: boolean;
/** Minimum amount of cycles required in the subscription. */
minCycles?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields for a Subscription Billing Policy. */
['SubscriptionBillingPolicyInput']: {
/** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */
interval: ValueTypes['SellingPlanInterval'];
/** The number of billing intervals between invoices. */
intervalCount: number;
/** Minimum amount of cycles required in the subscription. */
minCycles?: number | null;
/** Maximum amount of cycles required in the subscription. */
maxCycles?: number | null;
/** Specific anchor dates upon which the billing interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchorInput'][];
};
/** Represents a Subscription Contract. */
['SubscriptionContract']: AliasType<{
/** The subscription app that this subscription contract is registered to. */
app?: ValueTypes['App'];
/** URL of the subscription contract page on the subscription app. */
appAdminUrl?: boolean;
billingAttempts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionBillingAttemptConnection']
];
/** The billing policy associated with the subscription contract. */
billingPolicy?: ValueTypes['SubscriptionBillingPolicy'];
/** The date and time when the subscription contract was created. */
createdAt?: boolean;
/** The currency used for the subscription contract. */
currencyCode?: boolean;
/** The customer to whom the subscription contract belongs. */
customer?: ValueTypes['Customer'];
customerPaymentMethod?: [
{
/** Whether to show the customer's revoked payment method. */
showRevoked?: boolean | null;
},
ValueTypes['CustomerPaymentMethod']
];
/** The delivery method for each billing of the subscription contract. */
deliveryMethod?: ValueTypes['SubscriptionDeliveryMethod'];
/** The delivery policy associated with the subscription contract. */
deliveryPolicy?: ValueTypes['SubscriptionDeliveryPolicy'];
/** The delivery price for each billing of the subscription contract. */
deliveryPrice?: ValueTypes['MoneyV2'];
discounts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionManualDiscountConnection']
];
/** A globally-unique identifier. */
id?: boolean;
/** The current status of the last payment. */
lastPaymentStatus?: boolean;
/** The number of lines associated with the subscription contract. */
lineCount?: boolean;
lines?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionLineConnection']
];
/** The next billing date for the subscription contract. */
nextBillingDate?: boolean;
/** The note field that will be applied to the generated orders. */
note?: boolean;
orders?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['OrderConnection']
];
/** The order from which this contract originated. */
originOrder?: ValueTypes['Order'];
/** The current status of the subscription contract. */
status?: boolean;
/** The date and time when the subscription contract was updated. */
updatedAt?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SubscriptionContracts. */
['SubscriptionContractConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SubscriptionContractEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Specifies the input fields required to create a Subscription Contract. */
['SubscriptionContractCreateInput']: {
/** The ID of the customer to associate with the subscription contract. */
customerId: string;
/** The next billing date for the subscription contract. */
nextBillingDate: ValueTypes['DateTime'];
/** The currency used for the subscription contract. */
currencyCode: ValueTypes['CurrencyCode'];
/** The attributes used as input for the Subscription Draft. */
contract: ValueTypes['SubscriptionDraftInput'];
};
/** Return type for `subscriptionContractCreate` mutation. */
['SubscriptionContractCreatePayload']: AliasType<{
/** The Subscription Contract object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SubscriptionContract and a cursor during pagination. */
['SubscriptionContractEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SubscriptionContractEdge. */
node?: ValueTypes['SubscriptionContract'];
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `SubscriptionContractUserError`. */
['SubscriptionContractErrorCode']: SubscriptionContractErrorCode;
/** Possible status values of the last payment on a subscription contract. */
['SubscriptionContractLastPaymentStatus']: SubscriptionContractLastPaymentStatus;
/** Return type for `subscriptionContractSetNextBillingDate` mutation. */
['SubscriptionContractSetNextBillingDatePayload']: AliasType<{
/** The updated Subscription Contract object. */
contract?: ValueTypes['SubscriptionContract'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionContractUserError'];
__typename?: boolean;
}>;
/** Possible status values of a subscription. */
['SubscriptionContractSubscriptionStatus']: SubscriptionContractSubscriptionStatus;
/** Return type for `subscriptionContractUpdate` mutation. */
['SubscriptionContractUpdatePayload']: AliasType<{
/** The Subscription Contract object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Represents a Subscription Contract error. */
['SubscriptionContractUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Represents a Subscription Line Pricing Cycle Adjustment. */
['SubscriptionCyclePriceAdjustment']: AliasType<{
/** Price adjustment type. */
adjustmentType?: boolean;
/** Price adjustment value. */
adjustmentValue?: ValueTypes['SellingPlanPricingPolicyAdjustmentValue'];
/** The number of cycles required before this pricing policy applies. */
afterCycle?: boolean;
/** The computed price after the adjustments applied. */
computedPrice?: ValueTypes['MoneyV2'];
__typename?: boolean;
}>;
/** Describes the delivery method to use to get the physical goods to the customer. */
['SubscriptionDeliveryMethod']: AliasType<{
['...on SubscriptionDeliveryMethodShipping']: ValueTypes['SubscriptionDeliveryMethodShipping'];
__typename?: boolean;
}>;
/** Specifies delivery method fields for a subscription draft.
This is an input union: one, and only one, field can be provided.
The field provided will determine which delivery method is to be used.
Note: Only `shipping` is supported for now, but other inputs will be
added as they become supported in subscriptions. */
['SubscriptionDeliveryMethodInput']: {
/** Shipping delivery method input. */
shipping?: ValueTypes['SubscriptionDeliveryMethodShippingInput'] | null;
};
/** Represents a shipping delivery method: a mailing address and a shipping option. */
['SubscriptionDeliveryMethodShipping']: AliasType<{
/** The address to ship to. */
address?: ValueTypes['SubscriptionMailingAddress'];
/** The details of the shipping method to use. */
shippingOption?: ValueTypes['SubscriptionDeliveryMethodShippingOption'];
__typename?: boolean;
}>;
/** Specifies shipping delivery method fields.
This input accepts partial input. When a field is not provided,
its prior value is left unchanged. */
['SubscriptionDeliveryMethodShippingInput']: {
/** The address to ship to. */
address?: ValueTypes['MailingAddressInput'] | null;
/** The details of the shipping method to use. */
shippingOption?: ValueTypes['SubscriptionDeliveryMethodShippingOptionInput'] | null;
};
/** Represents the selected shipping option on a subscription contract. */
['SubscriptionDeliveryMethodShippingOption']: AliasType<{
/** The carrier service of the shipping option. */
carrierService?: ValueTypes['DeliveryCarrierService'];
/** The code of the shipping option. */
code?: boolean;
/** The description of the shipping option. */
description?: boolean;
/** The presentment title of the shipping option. */
presentmentTitle?: boolean;
/** The title of the shipping option. */
title?: boolean;
__typename?: boolean;
}>;
/** Specifies shipping option fields. */
['SubscriptionDeliveryMethodShippingOptionInput']: {
/** The title of the shipping option. */
title?: string | null;
/** The presentment title of the shipping option. */
presentmentTitle?: string | null;
/** The description of the shipping option. */
description?: string | null;
/** The code of the shipping option. */
code?: string | null;
/** The carrier service ID of the shipping option. */
carrierServiceId?: string | null;
};
/** Represents a Subscription Delivery Policy. */
['SubscriptionDeliveryPolicy']: AliasType<{
/** Specific anchor dates upon which the delivery interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchor'];
/** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */
interval?: boolean;
/** The number of delivery intervals between deliveries. */
intervalCount?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields for a Subscription Delivery Policy. */
['SubscriptionDeliveryPolicyInput']: {
/** The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc). */
interval: ValueTypes['SellingPlanInterval'];
/** The number of billing intervals between invoices. */
intervalCount: number;
/** Specific anchor dates upon which the delivery interval calculations should be made. */
anchors?: ValueTypes['SellingPlanAnchorInput'][];
};
/** Subscription draft discount types. */
['SubscriptionDiscount']: AliasType<{
['...on SubscriptionAppliedCodeDiscount']: ValueTypes['SubscriptionAppliedCodeDiscount'];
['...on SubscriptionManualDiscount']: ValueTypes['SubscriptionManualDiscount'];
__typename?: boolean;
}>;
/** Represents what a particular discount reduces from a line price. */
['SubscriptionDiscountAllocation']: AliasType<{
/** Allocation amount. */
amount?: ValueTypes['MoneyV2'];
/** Discount that created the allocation. */
discount?: ValueTypes['SubscriptionDiscount'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SubscriptionDiscounts. */
['SubscriptionDiscountConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SubscriptionDiscountEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination. */
['SubscriptionDiscountEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SubscriptionDiscountEdge. */
node?: ValueTypes['SubscriptionDiscount'];
__typename?: boolean;
}>;
/** Represents the subscription lines the discount applies on. */
['SubscriptionDiscountEntitledLines']: AliasType<{
/** Specify whether the subscription discount will apply on all subscription lines. */
all?: boolean;
lines?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionLineConnection']
];
__typename?: boolean;
}>;
/** The value of the discount and how it will be applied. */
['SubscriptionDiscountFixedAmountValue']: AliasType<{
/** The fixed amount value of the discount. */
amount?: ValueTypes['MoneyV2'];
/** Whether the amount is applied per item. */
appliesOnEachItem?: boolean;
__typename?: boolean;
}>;
/** The percentage value of the discount. */
['SubscriptionDiscountPercentageValue']: AliasType<{
/** The percentage value of the discount. */
percentage?: boolean;
__typename?: boolean;
}>;
/** The reason a discount on a subscription draft was rejected. */
['SubscriptionDiscountRejectionReason']: SubscriptionDiscountRejectionReason;
/** The value of the discount and how it will be applied. */
['SubscriptionDiscountValue']: AliasType<{
['...on SubscriptionDiscountFixedAmountValue']: ValueTypes['SubscriptionDiscountFixedAmountValue'];
['...on SubscriptionDiscountPercentageValue']: ValueTypes['SubscriptionDiscountPercentageValue'];
__typename?: boolean;
}>;
/** Represents a Subscription Draft. */
['SubscriptionDraft']: AliasType<{
/** The billing policy for the subscription contract. */
billingPolicy?: ValueTypes['SubscriptionBillingPolicy'];
/** The currency used for the subscription contract. */
currencyCode?: boolean;
/** The customer to whom the subscription contract belongs. */
customer?: ValueTypes['Customer'];
customerPaymentMethod?: [
{
/** Whether to show the customer's revoked payment method. */
showRevoked?: boolean | null;
},
ValueTypes['CustomerPaymentMethod']
];
/** The delivery method for each billing of the subscription contract. */
deliveryMethod?: ValueTypes['SubscriptionDeliveryMethod'];
/** The delivery policy for the subscription contract. */
deliveryPolicy?: ValueTypes['SubscriptionDeliveryPolicy'];
/** The delivery price for each billing the subscription contract. */
deliveryPrice?: ValueTypes['MoneyV2'];
discounts?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionDiscountConnection']
];
discountsAdded?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionDiscountConnection']
];
discountsRemoved?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionDiscountConnection']
];
discountsUpdated?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionDiscountConnection']
];
/** A globally-unique identifier. */
id?: boolean;
lines?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionLineConnection']
];
linesAdded?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionLineConnection']
];
linesRemoved?: [
{
/** Returns up to the first `n` elements from the list. */
first?: number | null /** Returns the elements that come after the specified cursor. */;
after?: string | null /** Returns up to the last `n` elements from the list. */;
last?: number | null /** Returns the elements that come before the specified cursor. */;
before?: string | null /** Reverse the order of the underlying list. */;
reverse?: boolean | null;
},
ValueTypes['SubscriptionLineConnection']
];
/** The next billing date for the subscription contract. */
nextBillingDate?: boolean;
/** The note field that will be applied to the generated orders. */
note?: boolean;
/** The original subscription contract. */
originalContract?: ValueTypes['SubscriptionContract'];
shippingOptions?: [
{
/** The address to delivery the subscription contract to. */
deliveryAddress?: ValueTypes['MailingAddressInput'] | null;
},
ValueTypes['SubscriptionShippingOptionResult']
];
/** The current status of the subscription contract. */
status?: boolean;
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftCommit` mutation. */
['SubscriptionDraftCommitPayload']: AliasType<{
/** The updated Subscription Contract object. */
contract?: ValueTypes['SubscriptionContract'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftDiscountAdd` mutation. */
['SubscriptionDraftDiscountAddPayload']: AliasType<{
/** The added Subscription Discount. */
discountAdded?: ValueTypes['SubscriptionManualDiscount'];
/** The Subscription Contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftDiscountCodeApply` mutation. */
['SubscriptionDraftDiscountCodeApplyPayload']: AliasType<{
/** The added subscription discount. */
appliedDiscount?: ValueTypes['SubscriptionAppliedCodeDiscount'];
/** The subscription contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftDiscountRemove` mutation. */
['SubscriptionDraftDiscountRemovePayload']: AliasType<{
/** The removed subscription draft discount. */
discountRemoved?: ValueTypes['SubscriptionDiscount'];
/** The subscription contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftDiscountUpdate` mutation. */
['SubscriptionDraftDiscountUpdatePayload']: AliasType<{
/** The updated Subscription Discount. */
discountUpdated?: ValueTypes['SubscriptionManualDiscount'];
/** The Subscription Contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Possible error codes that can be returned by `SubscriptionDraftUserError`. */
['SubscriptionDraftErrorCode']: SubscriptionDraftErrorCode;
/** Return type for `subscriptionDraftFreeShippingDiscountAdd` mutation. */
['SubscriptionDraftFreeShippingDiscountAddPayload']: AliasType<{
/** The added subscription free shipping discount. */
discountAdded?: ValueTypes['SubscriptionManualDiscount'];
/** The subscription contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftFreeShippingDiscountUpdate` mutation. */
['SubscriptionDraftFreeShippingDiscountUpdatePayload']: AliasType<{
/** The updated Subscription Discount. */
discountUpdated?: ValueTypes['SubscriptionManualDiscount'];
/** The Subscription Contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Specifies the input fields required to create a Subscription Draft. */
['SubscriptionDraftInput']: {
/** The current status of the subscription contract. */
status?: ValueTypes['SubscriptionContractSubscriptionStatus'] | null;
/** The ID of the payment method to be used for the subscription contract. */
paymentMethodId?: string | null;
/** The next billing date for the subscription contract. */
nextBillingDate?: ValueTypes['DateTime'] | null;
/** The billing policy for the subscription contract. */
billingPolicy?: ValueTypes['SubscriptionBillingPolicyInput'] | null;
/** The delivery policy for the subscription contract. */
deliveryPolicy?: ValueTypes['SubscriptionDeliveryPolicyInput'] | null;
/** The shipping price for each renewal the subscription contract. */
deliveryPrice?: ValueTypes['Decimal'] | null;
/** The delivery method for the subscription contract. */
deliveryMethod?: ValueTypes['SubscriptionDeliveryMethodInput'] | null;
/** The note field that will be applied to the generated orders. */
note?: string | null;
};
/** Return type for `subscriptionDraftLineAdd` mutation. */
['SubscriptionDraftLineAddPayload']: AliasType<{
/** The Subscription Contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The added Subscription Line. */
lineAdded?: ValueTypes['SubscriptionLine'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftLineRemove` mutation. */
['SubscriptionDraftLineRemovePayload']: AliasType<{
/** The list of updated subscription discounts impacted by the removed line. */
discountsUpdated?: ValueTypes['SubscriptionManualDiscount'];
/** The Subscription Contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The removed Subscription Line. */
lineRemoved?: ValueTypes['SubscriptionLine'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftLineUpdate` mutation. */
['SubscriptionDraftLineUpdatePayload']: AliasType<{
/** The Subscription Contract draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The updated Subscription Line. */
lineUpdated?: ValueTypes['SubscriptionLine'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Return type for `subscriptionDraftUpdate` mutation. */
['SubscriptionDraftUpdatePayload']: AliasType<{
/** The Subscription Draft object. */
draft?: ValueTypes['SubscriptionDraft'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['SubscriptionDraftUserError'];
__typename?: boolean;
}>;
/** Represents a Subscription Draft error. */
['SubscriptionDraftUserError']: AliasType<{
/** The error code. */
code?: boolean;
/** The path to the input field that caused the error. */
field?: boolean;
/** The error message. */
message?: boolean;
__typename?: boolean;
}>;
/** Specifies the input fields of a subscription free shipping discount on a contract. */
['SubscriptionFreeShippingDiscountInput']: {
/** The title associated with the subscription free shipping discount. */
title?: string | null;
/** The maximum number of times the subscription free shipping discount will be applied on orders. */
recurringCycleLimit?: number | null;
};
/** Represents a Subscription Line. */
['SubscriptionLine']: AliasType<{
/** The price per unit for the subscription line in the contract's currency. */
currentPrice?: ValueTypes['MoneyV2'];
/** List of custom attributes associated to the line item. */
customAttributes?: ValueTypes['Attribute'];
/** Discount allocations. */
discountAllocations?: ValueTypes['SubscriptionDiscountAllocation'];
/** The unique identifier. */
id?: boolean;
/** Total line price including all discounts. */
lineDiscountedPrice?: ValueTypes['MoneyV2'];
/** Describe the price changes of the line over time. */
pricingPolicy?: ValueTypes['SubscriptionPricingPolicy'];
/** The product id associated with the subscription line. */
productId?: boolean;
/** The quantity of the unit selected for the subscription line. */
quantity?: boolean;
/** Whether physical shipping is required for the variant. */
requiresShipping?: boolean;
/** The selling plan ID associated to the line.
Indicates which selling plan was used to create this
contract line initially. The selling plan ID is also used to
find the associated delivery profile.
The subscription contract, subscription line, or selling plan might have
changed. As a result, the selling plan's attributes might not
match the information on the contract. */
sellingPlanId?: boolean;
/** The selling plan name associated to the line. This name describes
the order line items created from this subscription line
for both merchants and customers.
The value can be different from the selling plan's name, because both
the selling plan's name and the subscription line's selling_plan_name
attribute can be updated independently. */
sellingPlanName?: boolean;
/** Variant SKU number of the item associated with the subscription line. */
sku?: boolean;
/** Whether the variant is taxable. */
taxable?: boolean;
/** Product title of the item associated with the subscription line. */
title?: boolean;
/** The product variant id associated with the subscription line. */
variantId?: boolean;
/** The image associated with the line item's variant or product. */
variantImage?: ValueTypes['Image'];
/** Product variant title of the item associated with the subscription line. */
variantTitle?: boolean;
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SubscriptionLines. */
['SubscriptionLineConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SubscriptionLineEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SubscriptionLine and a cursor during pagination. */
['SubscriptionLineEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SubscriptionLineEdge. */
node?: ValueTypes['SubscriptionLine'];
__typename?: boolean;
}>;
/** Specifies the input fields required to add a new subscription line to a contract. */
['SubscriptionLineInput']: {
/** The ID of the product variant the subscription line refers to. */
productVariantId: string;
/** The quantity of the product. */
quantity: number;
/** The price of the product. */
currentPrice: ValueTypes['Decimal'];
/** The custom attributes for this subscription line. */
customAttributes?: ValueTypes['AttributeInput'][];
/** The selling plan for the subscription line. */
sellingPlanId?: string | null;
/** The selling plan name for the subscription line.
Defaults to using the selling plan's current name when not specified. */
sellingPlanName?: string | null;
/** Describes expected price changes of the subscription line over time. */
pricingPolicy?: ValueTypes['SubscriptionPricingPolicyInput'] | null;
};
/** Specifies the input fields required to update a subscription line on a contract. */
['SubscriptionLineUpdateInput']: {
/** The ID of the product variant the subscription line refers to. */
productVariantId?: string | null;
/** The quantity of the product. */
quantity?: number | null;
/** The selling plan for the subscription line. */
sellingPlanId?: string | null;
/** The selling plan name for the subscription line. */
sellingPlanName?: string | null;
/** The price of the product. */
currentPrice?: ValueTypes['Decimal'] | null;
/** The custom attributes for this subscription line. */
customAttributes?: ValueTypes['AttributeInput'][];
/** Describes expected price changes of the subscription line over time. */
pricingPolicy?: ValueTypes['SubscriptionPricingPolicyInput'] | null;
};
/** Represents a Mailing Address on a Subscription. */
['SubscriptionMailingAddress']: AliasType<{
/** The first line of the address. Typically the street address or PO Box number. */
address1?: boolean;
/** The second line of the address. Typically the number of the apartment, suite, or unit. */
address2?: boolean;
/** The name of the city, district, village, or town. */
city?: boolean;
/** The name of the customer's company or organization. */
company?: boolean;
/** The name of the country. */
country?: boolean;
/** The two-letter code for the country of the address.
For example, US. */
countryCode?: boolean;
/** The first name of the customer. */
firstName?: boolean;
/** The last name of the customer. */
lastName?: boolean;
/** The full name of the customer, based on firstName and lastName. */
name?: boolean;
/** A unique phone number for the customer. Formatted using E.164 standard. For example, _+16135551111_. */
phone?: boolean;
/** The region of the address, such as the province, state, or district. */
province?: boolean;
/** The two-letter code for the region.
For example, ON. */
provinceCode?: boolean;
/** The zip or postal code of the address. */
zip?: boolean;
__typename?: boolean;
}>;
/** Custom subscription discount. */
['SubscriptionManualDiscount']: AliasType<{
/** Entitled line items used to apply the subscription discount on. */
entitledLines?: ValueTypes['SubscriptionDiscountEntitledLines'];
/** The unique identifier. */
id?: boolean;
/** The maximum number of times the subscription discount will be applied on orders. */
recurringCycleLimit?: boolean;
/** The reason that the discount on the subscription draft is rejected. */
rejectionReason?: boolean;
/** Type of line the discount applies on. */
targetType?: boolean;
/** The title associated with the subscription discount. */
title?: boolean;
/** The type of the subscription discount. */
type?: boolean;
/** The number of times the discount was applied. */
usageCount?: boolean;
/** The value of the subscription discount. */
value?: ValueTypes['SubscriptionDiscountValue'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple SubscriptionManualDiscounts. */
['SubscriptionManualDiscountConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['SubscriptionManualDiscountEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one SubscriptionManualDiscount and a cursor during pagination. */
['SubscriptionManualDiscountEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of SubscriptionManualDiscountEdge. */
node?: ValueTypes['SubscriptionManualDiscount'];
__typename?: boolean;
}>;
/** Represents the subscription lines the discount applies on. */
['SubscriptionManualDiscountEntitledLinesInput']: {
/** Specify whether the subscription discount will apply on all subscription lines. */
all?: boolean | null;
/** The ID of the lines to add to or remove from the subscription discount. */
lines?: ValueTypes['SubscriptionManualDiscountLinesInput'] | null;
};
/** Specifies the fixed amount value of the discount and distribution on the lines. */
['SubscriptionManualDiscountFixedAmountInput']: {
/** Fixed amount value. */
amount?: number | null;
/** Whether the amount is intended per line item or once per subscription. */
appliesOnEachItem?: boolean | null;
};
/** Specifies the input fields of a subscription discount on a contract. */
['SubscriptionManualDiscountInput']: {
/** The title associated with the subscription discount. */
title?: string | null;
/** Percentage or fixed amount value of the discount. */
value?: ValueTypes['SubscriptionManualDiscountValueInput'] | null;
/** The maximum number of times the subscription discount will be applied on orders. */
recurringCycleLimit?: number | null;
/** Entitled line items used to apply the subscription discount on. */
entitledLines?: ValueTypes['SubscriptionManualDiscountEntitledLinesInput'] | null;
};
/** Line items that a the discount refers to. */
['SubscriptionManualDiscountLinesInput']: {
/** The ID of the lines to add to the subscription discount. */
add?: string[];
/** The ID of the lines to remove from the subscription discount. */
remove?: string[];
};
/** Specifies the discount value and its distribution. */
['SubscriptionManualDiscountValueInput']: {
/** The percentage value of the discount. Value must be between 0 - 100. */
percentage?: number | null;
/** Fixed amount input in the currency defined by the subscription. */
fixedAmount?: ValueTypes['SubscriptionManualDiscountFixedAmountInput'] | null;
};
/** Represents a Subscription Line Pricing Policy. */
['SubscriptionPricingPolicy']: AliasType<{
/** The base price per unit for the subscription line in the contract's currency. */
basePrice?: ValueTypes['MoneyV2'];
/** The adjustments per cycle for the subscription line. */
cycleDiscounts?: ValueTypes['SubscriptionCyclePriceAdjustment'];
__typename?: boolean;
}>;
/** An array containing all pricing changes for each billing cycle. */
['SubscriptionPricingPolicyCycleDiscountsInput']: {
/** The cycle after which the pricing policy applies. */
afterCycle: number;
/** The price adjustment type. */
adjustmentType: ValueTypes['SellingPlanPricingPolicyAdjustmentType'];
/** The price adjustment value. */
adjustmentValue: ValueTypes['SellingPlanPricingPolicyValueInput'];
/** The computed price after the adjustments are applied. */
computedPrice: ValueTypes['Decimal'];
};
/** Describes expected price changes of the subscription line over time. */
['SubscriptionPricingPolicyInput']: {
/** The base price per unit for the subscription line in the contract's currency. */
basePrice: ValueTypes['Decimal'];
/** An array containing all pricing changes for each billing cycle. */
cycleDiscounts: ValueTypes['SubscriptionPricingPolicyCycleDiscountsInput'][];
};
/** A shipping option to deliver a subscription contract. */
['SubscriptionShippingOption']: AliasType<{
/** The carrier service that is providing this shipping option.
This field isn't currently supported and returns null. */
carrierService?: ValueTypes['DeliveryCarrierService'];
/** The code of the shipping option. */
code?: boolean;
/** The description of the shipping option. */
description?: boolean;
/** If a phone number is required for the shipping option. */
phoneRequired?: boolean;
/** The presentment title of the shipping option. */
presentmentTitle?: boolean;
/** The price of the shipping option. */
price?: ValueTypes['MoneyV2'];
/** The title of the shipping option. */
title?: boolean;
__typename?: boolean;
}>;
/** The result of the query to fetch shipping options for the subscription contract. */
['SubscriptionShippingOptionResult']: AliasType<{
['...on SubscriptionShippingOptionResultFailure']: ValueTypes['SubscriptionShippingOptionResultFailure'];
['...on SubscriptionShippingOptionResultSuccess']: ValueTypes['SubscriptionShippingOptionResultSuccess'];
__typename?: boolean;
}>;
/** Failure determining available shipping options for delivery of a subscription contract. */
['SubscriptionShippingOptionResultFailure']: AliasType<{
/** Failure reason. */
message?: boolean;
__typename?: boolean;
}>;
/** A shipping option for delivery of a subscription contract. */
['SubscriptionShippingOptionResultSuccess']: AliasType<{
/** Available shipping options. */
shippingOptions?: ValueTypes['SubscriptionShippingOption'];
__typename?: boolean;
}>;
/** A suggested transaction. Suggested transaction are usually used in the context of refunds
and exchanges. */
['SuggestedOrderTransaction']: AliasType<{
/** The masked account number associated with the payment method. */
accountNumber?: boolean;
/** The amount of the transaction. */
amount?: boolean;
/** The amount and currency of the suggested order transaction in shop and presentment currencies. */
amountSet?: ValueTypes['MoneyBag'];
/** The human-readable payment gateway name suggested to process the transaction. */
formattedGateway?: boolean;
/** The suggested payment gateway used to process the transaction. */
gateway?: boolean;
/** Specifies the kind of the suggested order transaction. */
kind?: boolean;
/** Specifies the available amount to refund on the gateway. Only available within SuggestedRefund. */
maximumRefundable?: boolean;
/** Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund. */
maximumRefundableSet?: ValueTypes['MoneyBag'];
/** The associated parent transaction, for example the authorization of a capture. */
parentTransaction?: ValueTypes['OrderTransaction'];
__typename?: boolean;
}>;
/** Specifies the kind of the suggested order transaction. */
['SuggestedOrderTransactionKind']: SuggestedOrderTransactionKind;
/** Represents a refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund. */
['SuggestedRefund']: AliasType<{
/** The total monetary value to be refunded. */
amount?: boolean;
/** The total monetary value to be refunded in shop and presentment currencies. */
amountSet?: ValueTypes['MoneyBag'];
/** The sum of all the discounted prices of the line items being refunded. */
discountedSubtotalSet?: ValueTypes['MoneyBag'];
/** The total monetary value available to refund. */
maximumRefundable?: boolean;
/** The total monetary value available to refund in shop and presentment currencies. */
maximumRefundableSet?: ValueTypes['MoneyBag'];
/** A list of duties to be refunded from the order. */
refundDuties?: ValueTypes['RefundDuty'];
/** A list of line items to be refunded, along with restock instructions. */
refundLineItems?: ValueTypes['RefundLineItem'];
/** The shipping costs to be refunded from the order. */
shipping?: ValueTypes['ShippingRefund'];
/** The sum of all the prices of the line items being refunded. */
subtotal?: boolean;
/** The sum of all the prices of the line items being refunded in shop and presentment currencies. */
subtotalSet?: ValueTypes['MoneyBag'];
/** A list of suggested order transactions. */
suggestedTransactions?: ValueTypes['SuggestedOrderTransaction'];
/** The total cart discount amount that was applied to all line items in this refund. */
totalCartDiscountAmountSet?: ValueTypes['MoneyBag'];
/** The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive. */
totalDutiesSet?: ValueTypes['MoneyBag'];
/** The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive. */
totalTaxSet?: ValueTypes['MoneyBag'];
/** The sum of the taxes being refunded from the order. The value must be positive. */
totalTaxes?: boolean;
__typename?: boolean;
}>;
/** Return type for `tagsAdd` mutation. */
['TagsAddPayload']: AliasType<{
/** The object that was updated. */
node?: ValueTypes['Node'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Return type for `tagsRemove` mutation. */
['TagsRemovePayload']: AliasType<{
/** The object that was updated. */
node?: ValueTypes['Node'];
/** The list of errors that occurred from executing the mutation. */
userErrors?: ValueTypes['UserError'];
__typename?: boolean;
}>;
/** Available customer tax exemptions. */
['TaxExemption']: TaxExemption;
/** Represents a single tax applied to the associated line item. */
['TaxLine']: AliasType<{
/** Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. */
channelLiable?: boolean;
/** The amount of tax, in shop currency, after discounts and before returns. */
price?: boolean;
/** The amount of tax, in shop and presentment currencies, after discounts and before returns. */
priceSet?: ValueTypes['MoneyBag'];
/** The proportion of the line item price that the tax represents as a decimal. */
rate?: boolean;
/** The proportion of the line item price that the tax represents as a percentage. */
ratePercentage?: boolean;
/** The name of the tax. */
title?: boolean;
__typename?: boolean;
}>;
/** A TenderTransaction represents a transaction with financial impact on a shop's balance sheet. A tender transaction always
represents actual money movement between a buyer and a shop. TenderTransactions can be used instead of OrderTransactions
for reconciling a shop's cash flow. A TenderTransaction is immutable once created. */
['TenderTransaction']: AliasType<{
/** The amount and currency of the tender transaction. */
amount?: ValueTypes['MoneyV2'];
/** A globally-unique identifier. */
id?: boolean;
/** Information about the payment method used for the transaction. */
paymentMethod?: boolean;
/** Date and time when the transaction was processed. */
processedAt?: boolean;
/** The remote gateway reference associated with the tender transaction. */
remoteReference?: boolean;
/** Whether the transaction is a test transaction. */
test?: boolean;
/** Information about the payment instrument used for the transaction. */
transactionDetails?: ValueTypes['TenderTransactionDetails'];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple TenderTransactions. */
['TenderTransactionConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['TenderTransactionEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes['PageInfo'];
__typename?: boolean;
}>;
/** Information about the credit card used for this transaction. */
['TenderTransactionCreditCardDetails']: AliasType<{
/** The name of the company that issued the customer's credit card. Example: `Visa`. */
creditCardCompany?: boolean;
/** The customer's credit card number, with all digits except the last 4 redacted. Example: `•••• •••• •••• 1234` */
creditCardNumber?: boolean;
__typename?: boolean;
}>;
/** Information about the payment instrument used for this transaction. */
['TenderTransactionDetails']: AliasType<{
['...on TenderTransactionCreditCardDetails']: ValueTypes['TenderTransactionCreditCardDetails'];
__typename?: boolean;
}>;
/** An auto-generated type which holds one TenderTransaction and a cursor during pagination. */
['TenderTransactionEdge']: AliasType<{
/** A cursor for use in pagination. */
cursor?: boolean;
/** The item at the end of TenderTransactionEdge. */
node?: ValueTypes['TenderTransaction'];
__typename?: boolean;
}>;
/** A sale associated with a tip. */
['TipSale']: AliasType<{
/** The type of order action that the sale represents. */
actionType?: boolean;
/** The unique identifier for the sale. */
id?: boolean;
/** The line item for the associated sale. */
lineItem?: ValueTypes['LineItem'];
/** The line type assocated with the sale. */
lineType?: boolean;
/** The number of units either ordered or intended to be returned. */
quantity?: boolean;
/** All individual taxes associated with the sale. */
taxes?: ValueTypes['SaleTax'];
/** The total sale amount after taxes and discounts. */
totalAmount?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale after taxes. */
totalDiscountAmountAfterTaxes?: ValueTypes['MoneyBag'];
/** The total discounts allocated to the sale before taxes. */
totalDiscountAmountBeforeTaxes?: ValueTypes['MoneyBag'];
/** The total amount of taxes for the sale. */
totalTaxAmount?: ValueTypes['MoneyBag'];
__typename?: boolean;
}>;
/** Specifies the fields for tracking information. */
['TrackingInfoInput']: {
/** The tracking number of the fulfillment. */
number?: string | null;
/** The URL to track the fulfillment. */
url?: string | null;
};
/** The input fields that specify all the possible fields for updating tracking information. */
['TrackingInfoUpdateInput']: {
/** Tracking information consisting of one or more tracking URLs and numbers associated with the fulfillment. */
trackingDetails?: ValueTypes['TrackingInfoInput'][];
/** The name of the tracking company. */
trackingCompany?: string | null;
/** Whether the customer will be notified of this update and future updates for the fulfillment.
If the field is left blank, then notifications won't be sent to the customer when the fulfillment is updated. */
notifyCustomer?: boolean | null;
};
/** Transaction fee related to an order transaction. */
['TransactionFee']: AliasType<{
/** Amount of the fee. */
amount?: ValueTypes['MoneyV2'];
/** Flat rate charge for a transaction. */
flatFee?: ValueTypes['MoneyV2'];
/** Name of the credit card flat fee. */
flatFeeName?: boolean;
/** A globally-unique identifier. */
id?: boolean;
/** Percentage charge. */
rate?: boolean;
/** Name of the credit card rate. */
rateName?: boolean;
/** Tax amount charged on the fee. */
taxAmount?: ValueTypes['MoneyV2'];
/** Name of the type of fee. */
type?: boolean;
__typename?: boolean;
}>;
/** Translatable content of a resource's field. */
['TranslatableContent']: AliasType<{
/** Hash digest representation of the content value. */
digest?: boolean;
/** The resource field that is being translated. */
key?: boolean;
/** Locale of the content. */
locale?: boolean;
/** Content value. */
value?: boolean;
__typename?: boolean;
}>;
/** A resource that has translatable fields. */
['TranslatableResource']: AliasType<{
/** GID of the resource. */
resourceId?: boolean;
/** Translatable content. */
translatableContent?: ValueTypes['TranslatableContent'];
translations?: [
{
/** Filters translations by locale. */
locale: string /** Filters by outdated translations. */;
outdated?: boolean | null;
},
ValueTypes['Translation']
];
__typename?: boolean;
}>;
/** An auto-generated type for paginating through multiple TranslatableResources. */
['TranslatableResourceConnection']: AliasType<{
/** A list of edges. */
edges?: ValueTypes['TranslatableResourceEdge'];
/** Information to aid in pagination. */
pageInfo?: ValueTypes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment