diff --git a/packages/core/platform/shopify/index.ts b/packages/core/platform/shopify/index.ts
index ec7ef5f4..af507764 100644
--- a/packages/core/platform/shopify/index.ts
+++ b/packages/core/platform/shopify/index.ts
@@ -3,6 +3,7 @@ import { createStorefrontApiClient, StorefrontApiClient } from "@shopify/storefr
import { createProductFeedMutation, fullSyncProductFeedMutation } from "./mutations/product-feed.admin"
import { subscribeWebhookMutation } from "./mutations/webhook.admin"
+import { normalizeProduct } from "./normalize"
import { getMenuQuery } from "./queries/menu.storefront"
import { getLatestProductFeedQuery } from "./queries/product-feed.admin"
import { getProductQuery, getProductsByHandleQuery } from "./queries/product.storefront"
@@ -10,6 +11,7 @@ import { getProductQuery, getProductsByHandleQuery } from "./queries/product.sto
import type { LatestProductFeedsQuery, ProductFeedCreateMutation, ProductFullSyncMutation, WebhookSubscriptionCreateMutation } from "./types/admin/admin.generated"
import type { WebhookSubscriptionTopic } from "./types/admin/admin.types"
import type { MenuQuery, ProductsByHandleQuery, SingleProductQuery } from "./types/storefront.generated"
+import { PlatformMenu, PlatformProduct } from "../types"
interface CreateShopifyClientProps {
storeDomain: string
@@ -36,7 +38,7 @@ export function createShopifyClient({ storefrontAccessToken, adminAccessToken, s
return {
getMenu: async (handle?: string) => getMenu(client!, handle),
getProduct: async (id: string) => getProduct(client!, id),
- getProductsByHandle: async (handle: string) => getProductsByHandle(client!, handle),
+ getProductByHandle: async (handle: string) => getProductByHandle(client!, handle),
subscribeWebhook: async (topic: `${WebhookSubscriptionTopic}`, callbackUrl: string) => subscribeWebhook(adminClient, topic, callbackUrl),
createProductFeed: async () => createProductFeed(adminClient),
fullSyncProductFeed: async (id: string) => fullSyncProductFeed(adminClient, id),
@@ -44,16 +46,30 @@ export function createShopifyClient({ storefrontAccessToken, adminAccessToken, s
}
}
-async function getMenu(client: StorefrontApiClient, handle: string = "main-menu") {
- return client.request
(getMenuQuery, { variables: { handle } })
+async function getMenu(client: StorefrontApiClient, handle: string = "main-menu"): Promise {
+ const response = await client.request(getMenuQuery, { variables: { handle } })
+ const mappedItems = response.data?.menu?.items?.map((item) => ({
+ title: item.title,
+ url: item.url,
+ }))
+
+ return {
+ items: mappedItems || [],
+ }
}
-async function getProduct(client: StorefrontApiClient, id: string) {
- return client.request(getProductQuery, { variables: { id } })
+async function getProduct(client: StorefrontApiClient, id: string): Promise {
+ const response = await client.request(getProductQuery, { variables: { id } })
+ const product = response.data?.product
+
+ return normalizeProduct(product)
}
-async function getProductsByHandle(client: StorefrontApiClient, handle: string) {
- return client.request(getProductsByHandleQuery, { variables: { query: `'${handle}'` } })
+async function getProductByHandle(client: StorefrontApiClient, handle: string) {
+ const response = await client.request(getProductsByHandleQuery, { variables: { query: `'${handle}'` } })
+ const product = response.data?.products?.edges?.find(Boolean)?.node
+
+ return normalizeProduct(product)
}
async function subscribeWebhook(client: AdminApiClient, topic: `${WebhookSubscriptionTopic}`, callbackUrl: string) {
diff --git a/packages/core/platform/shopify/normalize.ts b/packages/core/platform/shopify/normalize.ts
new file mode 100644
index 00000000..2ba30de3
--- /dev/null
+++ b/packages/core/platform/shopify/normalize.ts
@@ -0,0 +1,24 @@
+import { SingleProductQuery } from "./types/storefront.generated"
+import { PlatformProduct } from "../types"
+
+export function normalizeProduct(product: SingleProductQuery["product"]): PlatformProduct | null {
+ if (!product) return null
+ const { id, handle, title, description, descriptionHtml, options, priceRange, variants, featuredImage, images, tags, updatedAt, collections, seo } = product
+
+ return {
+ id,
+ handle,
+ title,
+ description,
+ descriptionHtml,
+ options,
+ priceRange,
+ tags,
+ updatedAt,
+ featuredImage,
+ seo,
+ variants: variants?.edges?.map(({ node }) => node) || [],
+ images: images?.edges?.map(({ node }) => node) || [],
+ collections: collections?.nodes || [],
+ }
+}
diff --git a/packages/core/platform/shopify/queries/product.storefront.ts b/packages/core/platform/shopify/queries/product.storefront.ts
index 19ed6666..3d228f45 100644
--- a/packages/core/platform/shopify/queries/product.storefront.ts
+++ b/packages/core/platform/shopify/queries/product.storefront.ts
@@ -22,7 +22,15 @@ export const getProductsByHandleQuery = `#graphql
products(first: 1, query: $query) {
edges {
node {
- ...singleProduct
+ ...singleProduct
+ collections(first: 15) {
+ nodes {
+ handle
+ title
+ description
+ updatedAt
+ }
+ }
}
}
}
diff --git a/packages/core/platform/shopify/types/admin/admin.generated.d.ts b/packages/core/platform/shopify/types/admin/admin.generated.d.ts
index fdad00e7..a3c3b450 100644
--- a/packages/core/platform/shopify/types/admin/admin.generated.d.ts
+++ b/packages/core/platform/shopify/types/admin/admin.generated.d.ts
@@ -1,44 +1,62 @@
/* eslint-disable eslint-comments/disable-enable-pair */
/* eslint-disable eslint-comments/no-unlimited-disable */
/* eslint-disable */
-import * as AdminTypes from './admin.types.d.ts';
+import * as AdminTypes from "./admin.types.d.ts"
-export type ProductFeedCreateMutationVariables = AdminTypes.Exact<{ [key: string]: never; }>;
+export type ProductFeedCreateMutationVariables = AdminTypes.Exact<{ [key: string]: never }>
-
-export type ProductFeedCreateMutation = { productFeedCreate?: AdminTypes.Maybe<{ productFeed?: AdminTypes.Maybe>, userErrors: Array> }> };
+export type ProductFeedCreateMutation = {
+ productFeedCreate?: AdminTypes.Maybe<{
+ productFeed?: AdminTypes.Maybe>
+ userErrors: Array>
+ }>
+}
export type ProductFullSyncMutationVariables = AdminTypes.Exact<{
- id: AdminTypes.Scalars['ID']['input'];
-}>;
+ id: AdminTypes.Scalars["ID"]["input"]
+}>
-
-export type ProductFullSyncMutation = { productFullSync?: AdminTypes.Maybe<{ userErrors: Array> }> };
+export type ProductFullSyncMutation = { productFullSync?: AdminTypes.Maybe<{ userErrors: Array> }> }
export type WebhookSubscriptionCreateMutationVariables = AdminTypes.Exact<{
- topic: AdminTypes.WebhookSubscriptionTopic;
- webhookSubscription: AdminTypes.WebhookSubscriptionInput;
-}>;
-
-
-export type WebhookSubscriptionCreateMutation = { webhookSubscriptionCreate?: AdminTypes.Maybe<{ userErrors: Array>, webhookSubscription?: AdminTypes.Maybe> }> };
-
-export type LatestProductFeedsQueryVariables = AdminTypes.Exact<{ [key: string]: never; }>;
+ topic: AdminTypes.WebhookSubscriptionTopic
+ webhookSubscription: AdminTypes.WebhookSubscriptionInput
+}>
+
+export type WebhookSubscriptionCreateMutation = {
+ webhookSubscriptionCreate?: AdminTypes.Maybe<{
+ userErrors: Array>
+ webhookSubscription?: AdminTypes.Maybe>
+ }>
+}
+export type LatestProductFeedsQueryVariables = AdminTypes.Exact<{ [key: string]: never }>
-export type LatestProductFeedsQuery = { productFeeds: { nodes: Array> } };
+export type LatestProductFeedsQuery = { productFeeds: { nodes: Array> } }
interface GeneratedQueryTypes {
- "#graphql\n query LatestProductFeeds {\n productFeeds(reverse: true, first: 1) {\n nodes {\n id\n country\n status\n }\n }\n }\n": {return: LatestProductFeedsQuery, variables: LatestProductFeedsQueryVariables},
+ "#graphql\n query LatestProductFeeds {\n productFeeds(reverse: true, first: 1) {\n nodes {\n id\n country\n status\n }\n }\n }\n": {
+ return: LatestProductFeedsQuery
+ variables: LatestProductFeedsQueryVariables
+ }
}
interface GeneratedMutationTypes {
- "#graphql\n mutation ProductFeedCreate {\n productFeedCreate {\n productFeed {\n status\n id\n }\n userErrors {\n field\n message\n }\n }\n }\n": {return: ProductFeedCreateMutation, variables: ProductFeedCreateMutationVariables},
- "#graphql\n mutation productFullSync($id: ID!) {\n productFullSync(id: $id) {\n userErrors {\n field\n message\n }\n }\n }\n": {return: ProductFullSyncMutation, variables: ProductFullSyncMutationVariables},
- "#graphql\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n id\n }\n }\n }\n": {return: WebhookSubscriptionCreateMutation, variables: WebhookSubscriptionCreateMutationVariables},
+ "#graphql\n mutation ProductFeedCreate {\n productFeedCreate {\n productFeed {\n status\n id\n }\n userErrors {\n field\n message\n }\n }\n }\n": {
+ return: ProductFeedCreateMutation
+ variables: ProductFeedCreateMutationVariables
+ }
+ "#graphql\n mutation productFullSync($id: ID!) {\n productFullSync(id: $id) {\n userErrors {\n field\n message\n }\n }\n }\n": {
+ return: ProductFullSyncMutation
+ variables: ProductFullSyncMutationVariables
+ }
+ "#graphql\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n id\n }\n }\n }\n": {
+ return: WebhookSubscriptionCreateMutation
+ variables: WebhookSubscriptionCreateMutationVariables
+ }
}
-declare module '@shopify/admin-api-client' {
- type InputMaybe = AdminTypes.InputMaybe;
+declare module "@shopify/admin-api-client" {
+ type InputMaybe = AdminTypes.InputMaybe
interface AdminQueries extends GeneratedQueryTypes {}
interface AdminMutations extends GeneratedMutationTypes {}
}
diff --git a/packages/core/platform/shopify/types/admin/admin.types.d.ts b/packages/core/platform/shopify/types/admin/admin.types.d.ts
index 956f72af..10e0f513 100644
--- a/packages/core/platform/shopify/types/admin/admin.types.d.ts
+++ b/packages/core/platform/shopify/types/admin/admin.types.d.ts
@@ -1,309 +1,307 @@
-export type Maybe = T | null;
-export type InputMaybe = Maybe;
-export type Exact = { [K in keyof T]: T[K] };
-export type MakeOptional = Omit & { [SubKey in K]?: Maybe };
-export type MakeMaybe = Omit & { [SubKey in K]: Maybe };
-export type MakeEmpty = { [_ in K]?: never };
-export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
+export type Maybe = T | null
+export type InputMaybe = Maybe
+export type Exact = { [K in keyof T]: T[K] }
+export type MakeOptional = Omit & { [SubKey in K]?: Maybe }
+export type MakeMaybe = Omit & { [SubKey in K]: Maybe }
+export type MakeEmpty = { [_ in K]?: never }
+export type Incremental = T | { [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never }
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
- ID: { input: string; output: string; }
- String: { input: string; output: string; }
- Boolean: { input: boolean; output: boolean; }
- Int: { input: number; output: number; }
- Float: { input: number; output: number; }
- ARN: { input: any; output: any; }
- Date: { input: any; output: any; }
- DateTime: { input: any; output: any; }
- Decimal: { input: any; output: any; }
- FormattedString: { input: any; output: any; }
- HTML: { input: any; output: any; }
- JSON: { input: any; output: any; }
- Money: { input: any; output: any; }
- StorefrontID: { input: any; output: any; }
- URL: { input: any; output: any; }
- UnsignedInt64: { input: any; output: any; }
- UtcOffset: { input: any; output: any; }
-};
+ ID: { input: string; output: string }
+ String: { input: string; output: string }
+ Boolean: { input: boolean; output: boolean }
+ Int: { input: number; output: number }
+ Float: { input: number; output: number }
+ ARN: { input: any; output: any }
+ Date: { input: any; output: any }
+ DateTime: { input: any; output: any }
+ Decimal: { input: any; output: any }
+ FormattedString: { input: any; output: any }
+ HTML: { input: any; output: any }
+ JSON: { input: any; output: any }
+ Money: { input: any; output: any }
+ StorefrontID: { input: any; output: any }
+ URL: { input: any; output: any }
+ UnsignedInt64: { input: any; output: any }
+ UtcOffset: { input: any; output: any }
+}
/** A checkout that was abandoned by the customer. */
-export type AbandonedCheckout = Navigable & Node & {
- __typename?: 'AbandonedCheckout';
- /** The URL for the buyer to recover their checkout. */
- abandonedCheckoutUrl: Scalars['URL']['output'];
- /**
- * A default cursor that returns the single next record, sorted ascending by ID.
- *
- */
- defaultCursor: Scalars['String']['output'];
- /** A globally-unique ID. */
- id: Scalars['ID']['output'];
- /** A list of the line items in this checkout. */
- lineItems: AbandonedCheckoutLineItemConnection;
- /** The number of products in the checkout. */
- lineItemsQuantity: Scalars['Int']['output'];
- /**
- * The sum of all items in the checkout, including discounts, shipping, taxes, and tips.
- *
- */
- totalPriceSet: MoneyBag;
-};
-
+export type AbandonedCheckout = Navigable &
+ Node & {
+ __typename?: "AbandonedCheckout"
+ /** The URL for the buyer to recover their checkout. */
+ abandonedCheckoutUrl: Scalars["URL"]["output"]
+ /**
+ * A default cursor that returns the single next record, sorted ascending by ID.
+ *
+ */
+ defaultCursor: Scalars["String"]["output"]
+ /** A globally-unique ID. */
+ id: Scalars["ID"]["output"]
+ /** A list of the line items in this checkout. */
+ lineItems: AbandonedCheckoutLineItemConnection
+ /** The number of products in the checkout. */
+ lineItemsQuantity: Scalars["Int"]["output"]
+ /**
+ * The sum of all items in the checkout, including discounts, shipping, taxes, and tips.
+ *
+ */
+ totalPriceSet: MoneyBag
+ }
/** A checkout that was abandoned by the customer. */
export type AbandonedCheckoutLineItemsArgs = {
- after?: InputMaybe;
- before?: InputMaybe;
- first?: InputMaybe;
- last?: InputMaybe;
- reverse?: InputMaybe;
-};
+ after?: InputMaybe
+ before?: InputMaybe
+ first?: InputMaybe
+ last?: InputMaybe
+ reverse?: InputMaybe
+}
/** A single line item in an abandoned checkout. */
export type AbandonedCheckoutLineItem = Node & {
- __typename?: 'AbandonedCheckoutLineItem';
+ __typename?: "AbandonedCheckoutLineItem"
/** A list of extra information that has been added to the line item. */
- customAttributes: Array;
+ customAttributes: Array
/** Final total price for the entire quantity of this line item, including discounts. */
- discountedTotalPriceSet: MoneyBag;
+ discountedTotalPriceSet: MoneyBag
/**
* The total price for the entire quantity of this line item, after all discounts are applied, at both the line item and code-based line item level.
*
*/
- discountedTotalPriceWithCodeDiscount: MoneyBag;
+ discountedTotalPriceWithCodeDiscount: MoneyBag
/**
* The price of a single variant unit after discounts are applied at the line item level, in shop and presentment currencies.
*
*/
- discountedUnitPriceSet: MoneyBag;
+ discountedUnitPriceSet: MoneyBag
/**
* The price of a single variant unit after all discounts are applied, at both the line item and code-based line item level.
*
*/
- discountedUnitPriceWithCodeDiscount: MoneyBag;
+ discountedUnitPriceWithCodeDiscount: MoneyBag
/** A globally-unique ID. */
- id: Scalars['ID']['output'];
+ id: Scalars["ID"]["output"]
/**
* The image associated with the line item's variant or product.
* NULL if the line item has no product, or if neither the variant nor the product have an image.
*
*/
- image?: Maybe;
+ image?: Maybe
/** Original total price for the entire quantity of this line item, before discounts. */
- originalTotalPriceSet: MoneyBag;
+ originalTotalPriceSet: MoneyBag
/** Original price for a single unit of this line item, before discounts. */
- originalUnitPriceSet: MoneyBag;
+ originalUnitPriceSet: MoneyBag
/**
* Product for this line item.
* NULL for custom line items and products that were deleted after checkout began.
*
*/
- product?: Maybe;
+ product?: Maybe
/** The quantity of the line item. */
- quantity: Scalars['Int']['output'];
+ quantity: Scalars["Int"]["output"]
/** SKU for the inventory item associated with the variant, if any. */
- sku?: Maybe;
+ sku?: Maybe
/** Title of the line item. Defaults to the product's title. */
- title?: Maybe;
+ title?: Maybe
/**
* Product variant for this line item.
* NULL for custom line items and variants that were deleted after checkout began.
*
*/
- variant?: Maybe;
+ variant?: Maybe
/**
* Title of the variant for this line item.
* NULL for custom line items and products that don't have distinct variants.
*
*/
- variantTitle?: Maybe;
-};
+ variantTitle?: Maybe
+}
/**
* An auto-generated type for paginating through multiple AbandonedCheckoutLineItems.
*
*/
export type AbandonedCheckoutLineItemConnection = {
- __typename?: 'AbandonedCheckoutLineItemConnection';
+ __typename?: "AbandonedCheckoutLineItemConnection"
/** A list of edges. */
- edges: Array;
+ edges: Array
/** A list of the nodes contained in AbandonedCheckoutLineItemEdge. */
- nodes: Array;
+ nodes: Array
/** Information to aid in pagination. */
- pageInfo: PageInfo;
-};
+ pageInfo: PageInfo
+}
/**
* An auto-generated type which holds one AbandonedCheckoutLineItem and a cursor during pagination.
*
*/
export type AbandonedCheckoutLineItemEdge = {
- __typename?: 'AbandonedCheckoutLineItemEdge';
+ __typename?: "AbandonedCheckoutLineItemEdge"
/** A cursor for use in pagination. */
- cursor: Scalars['String']['output'];
+ cursor: Scalars["String"]["output"]
/** The item at the end of AbandonedCheckoutLineItemEdge. */
- node: AbandonedCheckoutLineItem;
-};
+ node: AbandonedCheckoutLineItem
+}
/** A browse, cart, or checkout that was abandoned by a customer. */
export type Abandonment = Node & {
- __typename?: 'Abandonment';
+ __typename?: "Abandonment"
/** The abandonment payload for the abandoned checkout. */
- abandonedCheckoutPayload?: Maybe;
+ abandonedCheckoutPayload?: Maybe
/** The abandonment type. */
- abandonmentType: AbandonmentAbandonmentType;
+ abandonmentType: AbandonmentAbandonmentType
/** The app associated with an abandoned checkout. */
- app: App;
+ app: App
/** Permalink to the cart page. */
- cartUrl?: Maybe;
+ cartUrl?: Maybe
/** The date and time when the abandonment was created. */
- createdAt: Scalars['DateTime']['output'];
+ createdAt: Scalars["DateTime"]["output"]
/** The customer who abandoned this event. */
- customer: Customer;
+ customer: Customer
/** Whether the customer has a draft order since this abandonment has been abandoned. */
- customerHasNoDraftOrderSinceAbandonment: Scalars['Boolean']['output'];
+ customerHasNoDraftOrderSinceAbandonment: Scalars["Boolean"]["output"]
/** Whether the customer has completed an order since this checkout has been abandoned. */
- customerHasNoOrderSinceAbandonment: Scalars['Boolean']['output'];
+ customerHasNoOrderSinceAbandonment: Scalars["Boolean"]["output"]
/** The number of days since the last abandonment email was sent to the customer. */
- daysSinceLastAbandonmentEmail: Scalars['Int']['output'];
+ daysSinceLastAbandonmentEmail: Scalars["Int"]["output"]
/** When the email was sent, if that's the case. */
- emailSentAt?: Maybe;
+ emailSentAt?: Maybe
/** The email state (e.g., sent or not sent). */
- emailState?: Maybe;
+ emailState?: Maybe
/** The number of hours since the customer has last abandoned a checkout. */
- hoursSinceLastAbandonedCheckout?: Maybe;
+ hoursSinceLastAbandonedCheckout?: Maybe
/** A globally-unique ID. */
- id: Scalars['ID']['output'];
+ id: Scalars["ID"]["output"]
/** Whether the products in abandonment are available. */
- inventoryAvailable: Scalars['Boolean']['output'];
+ inventoryAvailable: Scalars["Boolean"]["output"]
/** Whether the abandonment event comes from the Online Store sales channel. */
- isFromOnlineStore: Scalars['Boolean']['output'];
+ isFromOnlineStore: Scalars["Boolean"]["output"]
/** Whether the abandonment event comes from the Shop app sales channel. */
- isFromShopApp: Scalars['Boolean']['output'];
+ isFromShopApp: Scalars["Boolean"]["output"]
/** Whether the abandonment event comes from Shop Pay. */
- isFromShopPay: Scalars['Boolean']['output'];
+ isFromShopPay: Scalars["Boolean"]["output"]
/** Whether the customer didn't complete another most significant step since this abandonment. */
- isMostSignificantAbandonment: Scalars['Boolean']['output'];
+ isMostSignificantAbandonment: Scalars["Boolean"]["output"]
/** The date for the latest browse abandonment. */
- lastBrowseAbandonmentDate: Scalars['DateTime']['output'];
+ lastBrowseAbandonmentDate: Scalars["DateTime"]["output"]
/** The date for the latest cart abandonment. */
- lastCartAbandonmentDate: Scalars['DateTime']['output'];
+ lastCartAbandonmentDate: Scalars["DateTime"]["output"]
/** The date for the latest checkout abandonment. */
- lastCheckoutAbandonmentDate: Scalars['DateTime']['output'];
+ lastCheckoutAbandonmentDate: Scalars["DateTime"]["output"]
/** The most recent step type. */
- mostRecentStep: AbandonmentAbandonmentType;
+ mostRecentStep: AbandonmentAbandonmentType
/** The products added to the cart during the customer abandoned visit. */
- productsAddedToCart: CustomerVisitProductInfoConnection;
+ productsAddedToCart: CustomerVisitProductInfoConnection
/** The products viewed during the customer abandoned visit. */
- productsViewed: CustomerVisitProductInfoConnection;
+ productsViewed: CustomerVisitProductInfoConnection
/** The date and time when the visit started. */
- visitStartedAt?: Maybe;
-};
-
+ visitStartedAt?: Maybe
+}
/** A browse, cart, or checkout that was abandoned by a customer. */
export type AbandonmentProductsAddedToCartArgs = {
- after?: InputMaybe;
- before?: InputMaybe;
- first?: InputMaybe;
- last?: InputMaybe;
- reverse?: InputMaybe;
-};
-
+ after?: InputMaybe
+ before?: InputMaybe
+ first?: InputMaybe
+ last?: InputMaybe
+ reverse?: InputMaybe
+}
/** A browse, cart, or checkout that was abandoned by a customer. */
export type AbandonmentProductsViewedArgs = {
- after?: InputMaybe;
- before?: InputMaybe;
- first?: InputMaybe;
- last?: InputMaybe;
- reverse?: InputMaybe;
-};
+ after?: InputMaybe
+ before?: InputMaybe
+ first?: InputMaybe
+ last?: InputMaybe
+ reverse?: InputMaybe
+}
/** Specifies the abandonment type. */
export enum AbandonmentAbandonmentType {
/** The abandonment event is an abandoned browse. */
- Browse = 'BROWSE',
+ Browse = "BROWSE",
/** The abandonment event is an abandoned cart. */
- Cart = 'CART',
+ Cart = "CART",
/** The abandonment event is an abandoned checkout. */
- Checkout = 'CHECKOUT'
+ Checkout = "CHECKOUT",
}
/** Specifies the delivery state of a marketing activity. */
export enum AbandonmentDeliveryState {
/** The marketing activity action has not yet been sent. */
- NotSent = 'NOT_SENT',
+ NotSent = "NOT_SENT",
/** The marketing activity action has been scheduled for later delivery. */
- Scheduled = 'SCHEDULED',
+ Scheduled = "SCHEDULED",
/** The marketing activity action has been sent. */
- Sent = 'SENT'
+ Sent = "SENT",
}
/** Specifies the email state. */
export enum AbandonmentEmailState {
/** The email has not yet been sent. */
- NotSent = 'NOT_SENT',
+ NotSent = "NOT_SENT",
/** The email has been scheduled for later delivery. */
- Scheduled = 'SCHEDULED',
+ Scheduled = "SCHEDULED",
/** The email has been sent. */
- Sent = 'SENT'
+ Sent = "SENT",
}
/** Return type for `abandonmentEmailStateUpdate` mutation. */
export type AbandonmentEmailStateUpdatePayload = {
- __typename?: 'AbandonmentEmailStateUpdatePayload';
+ __typename?: "AbandonmentEmailStateUpdatePayload"
/** The updated abandonment. */
- abandonment?: Maybe;
+ abandonment?: Maybe
/** The list of errors that occurred from executing the mutation. */
- userErrors: Array;
-};
+ userErrors: Array
+}
/** An error that occurs during the execution of `AbandonmentEmailStateUpdate`. */
export type AbandonmentEmailStateUpdateUserError = DisplayableError & {
- __typename?: 'AbandonmentEmailStateUpdateUserError';
+ __typename?: "AbandonmentEmailStateUpdateUserError"
/** The error code. */
- code?: Maybe;
+ code?: Maybe
/** The path to the input field that caused the error. */
- field?: Maybe>;
+ field?: Maybe>
/** The error message. */
- message: Scalars['String']['output'];
-};
+ message: Scalars["String"]["output"]
+}
/** Possible error codes that can be returned by `AbandonmentEmailStateUpdateUserError`. */
export enum AbandonmentEmailStateUpdateUserErrorCode {
/** Unable to find an Abandonment for the provided ID. */
- AbandonmentNotFound = 'ABANDONMENT_NOT_FOUND'
+ AbandonmentNotFound = "ABANDONMENT_NOT_FOUND",
}
/** Return type for `abandonmentUpdateActivitiesDeliveryStatuses` mutation. */
export type AbandonmentUpdateActivitiesDeliveryStatusesPayload = {
- __typename?: 'AbandonmentUpdateActivitiesDeliveryStatusesPayload';
+ __typename?: "AbandonmentUpdateActivitiesDeliveryStatusesPayload"
/** The updated abandonment. */
- abandonment?: Maybe;
+ abandonment?: Maybe
/** The list of errors that occurred from executing the mutation. */
- userErrors: Array;
-};
+ userErrors: Array
+}
/** An error that occurs during the execution of `AbandonmentUpdateActivitiesDeliveryStatuses`. */
export type AbandonmentUpdateActivitiesDeliveryStatusesUserError = DisplayableError & {
- __typename?: 'AbandonmentUpdateActivitiesDeliveryStatusesUserError';
+ __typename?: "AbandonmentUpdateActivitiesDeliveryStatusesUserError"
/** The error code. */
- code?: Maybe;
+ code?: Maybe
/** The path to the input field that caused the error. */
- field?: Maybe>;
+ field?: Maybe>
/** The error message. */
- message: Scalars['String']['output'];
-};
+ message: Scalars["String"]["output"]
+}
/** Possible error codes that can be returned by `AbandonmentUpdateActivitiesDeliveryStatusesUserError`. */
export enum AbandonmentUpdateActivitiesDeliveryStatusesUserErrorCode {
/** Unable to find an Abandonment for the provided ID. */
- AbandonmentNotFound = 'ABANDONMENT_NOT_FOUND',
+ AbandonmentNotFound = "ABANDONMENT_NOT_FOUND",
/** Unable to find delivery status info for the provided ID. */
- DeliveryStatusInfoNotFound = 'DELIVERY_STATUS_INFO_NOT_FOUND',
+ DeliveryStatusInfoNotFound = "DELIVERY_STATUS_INFO_NOT_FOUND",
/** Unable to find a marketing activity for the provided ID. */
- MarketingActivityNotFound = 'MARKETING_ACTIVITY_NOT_FOUND'
+ MarketingActivityNotFound = "MARKETING_ACTIVITY_NOT_FOUND",
}
/**
@@ -311,96 +309,97 @@ export enum AbandonmentUpdateActivitiesDeliveryStatusesUserErrorCode {
*
*/
export type AccessScope = {
- __typename?: 'AccessScope';
+ __typename?: "AccessScope"
/** A description of the actions that the access scope allows an app to perform. */
- description: Scalars['String']['output'];
+ description: Scalars["String"]["output"]
/**
* A readable string that represents the access scope. The string usually follows the format `{action}_{resource}`. `{action}` is `read` or `write`, and `{resource}` is the resource that the action can be performed on. `{action}` and `{resource}` are separated by an underscore. For example, `read_orders` or `write_products`.
*
*/
- handle: Scalars['String']['output'];
-};
+ handle: Scalars["String"]["output"]
+}
/** Represents an operation publishing all products to a publication. */
-export type AddAllProductsOperation = Node & ResourceOperation & {
- __typename?: 'AddAllProductsOperation';
- /** A globally-unique ID. */
- id: Scalars['ID']['output'];
- /** The count of processed rows, summing imported, failed, and skipped rows. */
- processedRowCount?: Maybe;
- /** Represents a rows objects within this background operation. */
- rowCount?: Maybe;
- /** The status of this operation. */
- status: ResourceOperationStatus;
-};
+export type AddAllProductsOperation = Node &
+ ResourceOperation & {
+ __typename?: "AddAllProductsOperation"
+ /** A globally-unique ID. */
+ id: Scalars["ID"]["output"]
+ /** The count of processed rows, summing imported, failed, and skipped rows. */
+ processedRowCount?: Maybe
+ /** Represents a rows objects within this background operation. */
+ rowCount?: Maybe
+ /** The status of this operation. */
+ status: ResourceOperationStatus
+ }
/** The additional fees that have been applied to the order. */
export type AdditionalFee = Node & {
- __typename?: 'AdditionalFee';
+ __typename?: "AdditionalFee"
/** A globally-unique ID. */
- id: Scalars['ID']['output'];
+ id: Scalars["ID"]["output"]
/** The name of the additional fee. */
- name: Scalars['String']['output'];
+ name: Scalars["String"]["output"]
/** The price of the additional fee. */
- price: MoneyBag;
+ price: MoneyBag
/** A list of taxes charged on the additional fee. */
- taxLines: Array;
-};
+ taxLines: Array
+}
/** A sale associated with an additional fee charge. */
export type AdditionalFeeSale = Sale & {
- __typename?: 'AdditionalFeeSale';
+ __typename?: "AdditionalFeeSale"
/** The type of order action that the sale represents. */
- actionType: SaleActionType;
+ actionType: SaleActionType
/** The additional fees for the associated sale. */
- additionalFee: SaleAdditionalFee;
+ additionalFee: SaleAdditionalFee
/** The unique ID for the sale. */
- id: Scalars['ID']['output'];
+ id: Scalars["ID"]["output"]
/** The line type assocated with the sale. */
- lineType: SaleLineType;
+ lineType: SaleLineType
/** The number of units either ordered or intended to be returned. */
- quantity?: Maybe;
+ quantity?: Maybe
/** All individual taxes associated with the sale. */
- taxes: Array;
+ taxes: Array
/** The total sale amount after taxes and discounts. */
- totalAmount: MoneyBag;
+ totalAmount: MoneyBag
/** The total discounts allocated to the sale after taxes. */
- totalDiscountAmountAfterTaxes: MoneyBag;
+ totalDiscountAmountAfterTaxes: MoneyBag
/** The total discounts allocated to the sale before taxes. */
- totalDiscountAmountBeforeTaxes: MoneyBag;
+ totalDiscountAmountBeforeTaxes: MoneyBag
/** The total amount of taxes for the sale. */
- totalTaxAmount: MoneyBag;
-};
+ totalTaxAmount: MoneyBag
+}
/** A sale associated with an order price adjustment. */
export type AdjustmentSale = Sale & {
- __typename?: 'AdjustmentSale';
+ __typename?: "AdjustmentSale"
/** The type of order action that the sale represents. */
- actionType: SaleActionType;
+ actionType: SaleActionType
/** The unique ID for the sale. */
- id: Scalars['ID']['output'];
+ id: Scalars["ID"]["output"]
/** The line type assocated with the sale. */
- lineType: SaleLineType;
+ lineType: SaleLineType
/** The number of units either ordered or intended to be returned. */
- quantity?: Maybe;
+ quantity?: Maybe
/** All individual taxes associated with the sale. */
- taxes: Array;
+ taxes: Array
/** The total sale amount after taxes and discounts. */
- totalAmount: MoneyBag;
+ totalAmount: MoneyBag
/** The total discounts allocated to the sale after taxes. */
- totalDiscountAmountAfterTaxes: MoneyBag;
+ totalDiscountAmountAfterTaxes: MoneyBag
/** The total discounts allocated to the sale before taxes. */
- totalDiscountAmountBeforeTaxes: MoneyBag;
+ totalDiscountAmountBeforeTaxes: MoneyBag
/** The total amount of taxes for the sale. */
- totalTaxAmount: MoneyBag;
-};
+ totalTaxAmount: MoneyBag
+}
/** Targets all items the cart for a specified discount. */
export type AllDiscountItems = {
- __typename?: 'AllDiscountItems';
+ __typename?: "AllDiscountItems"
/** Whether all items are eligible for the discount. This value always returns `true`. */
- allItems: Scalars['Boolean']['output'];
-};
+ allItems: Scalars["Boolean"]["output"]
+}
/**
* A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).
@@ -408,246 +407,246 @@ export type AllDiscountItems = {
*
*/
export type ApiVersion = {
- __typename?: 'ApiVersion';
+ __typename?: "ApiVersion"
/** The human-readable name of the version. */
- displayName: Scalars['String']['output'];
+ displayName: Scalars["String"]["output"]
/** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */
- handle: Scalars['String']['output'];
+ handle: Scalars["String"]["output"]
/** Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning). */
- supported: Scalars['Boolean']['output'];
-};
+ supported: Scalars["Boolean"]["output"]
+}
/** A Shopify application. */
export type App = Node & {
- __typename?: 'App';
+ __typename?: "App"
/** A unique application API identifier. */
- apiKey: Scalars['String']['output'];
+ apiKey: Scalars["String"]["output"]
/** App store page URL of the app. */
- appStoreAppUrl?: Maybe;
+ appStoreAppUrl?: Maybe
/** App store page URL of the developer who created the app. */
- appStoreDeveloperUrl?: Maybe;
+ appStoreDeveloperUrl?: Maybe
/** The access scopes available to the app. */
- availableAccessScopes: Array;
+ availableAccessScopes: Array
/** Banner image for the app. */
- banner: Image;
+ banner: Image
/** Description of the app. */
- description?: Maybe;
+ description?: Maybe
/** The name of the app developer. */
- developerName?: Maybe;
+ developerName?: Maybe
/** The type of app developer. */
- developerType: AppDeveloperType;
+ developerType: AppDeveloperType
/**
* Website of the developer who created the app.
* @deprecated Use `appStoreDeveloperUrl` instead.
*/
- developerUrl: Scalars['URL']['output'];
+ developerUrl: Scalars["URL"]["output"]
/** Whether the app uses the Embedded App SDK. */
- embedded: Scalars['Boolean']['output'];
+ embedded: Scalars["Boolean"]["output"]
/** Requirements that must be met before the app can be installed. */
- failedRequirements: Array;
+ failedRequirements: Array
/** A list of app features that are shown in the Shopify App Store listing. */
- features: Array;
+ features: Array
/** Feedback from this app about the store. */
- feedback?: Maybe;
+ feedback?: Maybe
/** Handle of the app. */
- handle?: Maybe;
+ handle?: Maybe
/** Icon that represents the app. */
- icon: Image;
+ icon: Image
/** A globally-unique ID. */
- id: Scalars['ID']['output'];
+ id: Scalars["ID"]["output"]
/** Webpage where you can install the app. */
- installUrl?: Maybe;
+ installUrl?: Maybe
/**
* Corresponding AppInstallation for this shop and App.
* Returns null if the App is not installed.
*
*/
- installation?: Maybe;
+ installation?: Maybe
/**
* Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use.
*
*/
- isPostPurchaseAppInUse: Scalars['Boolean']['output'];
+ isPostPurchaseAppInUse: Scalars["Boolean"]["output"]
/**
* Webpage that the app starts in.
* @deprecated Use AppInstallation.launchUrl instead
*/
- launchUrl: Scalars['URL']['output'];
+ launchUrl: Scalars["URL"]["output"]
/**
* Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.
*
* @deprecated Use AppInstallation.navigationItems instead
*/
- navigationItems: Array;
+ navigationItems: Array
/** Whether the app was previously installed on the current shop. */
- previouslyInstalled: Scalars['Boolean']['output'];
+ previouslyInstalled: Scalars["Boolean"]["output"]
/** Detailed information about the app pricing. */
- pricingDetails?: Maybe;
+ pricingDetails?: Maybe
/** Summary of the app pricing details. */
- pricingDetailsSummary: Scalars['String']['output'];
+ pricingDetailsSummary: Scalars["String"]["output"]
/** Link to app privacy policy. */
- privacyPolicyUrl?: Maybe;
+ privacyPolicyUrl?: Maybe
/** The public category for the app. */
- publicCategory: AppPublicCategory;
+ publicCategory: AppPublicCategory
/** Whether the app is published to the Shopify App Store. */
- published: Scalars['Boolean']['output'];
+ published: Scalars["Boolean"]["output"]
/** The access scopes requested by the app. */
- requestedAccessScopes: Array;
+ requestedAccessScopes: Array
/** Screenshots of the app. */
- screenshots: Array;
+ screenshots: Array
/** Whether the app was developed by Shopify. */
- shopifyDeveloped: Scalars['Boolean']['output'];
+ shopifyDeveloped: Scalars["Boolean"]["output"]
/** Name of the app. */
- title: Scalars['String']['output'];
+ title: Scalars["String"]["output"]
/**
* Message that appears when the app is uninstalled. For example:
* By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time.
*
*/
- uninstallMessage: Scalars['String']['output'];
+ uninstallMessage: Scalars["String"]["output"]
/**
* Webpage where you can uninstall the app.
* @deprecated Use AppInstallation.uninstallUrl instead
*/
- uninstallUrl?: Maybe;
+ uninstallUrl?: Maybe
/** The webhook API version for the app. */
- webhookApiVersion: Scalars['String']['output'];
-};
+ webhookApiVersion: Scalars["String"]["output"]
+}
/**
* A catalog that defines the publication associated with an app.
*
*/
-export type AppCatalog = Catalog & Node & {
- __typename?: 'AppCatalog';
- /** The apps associated with the catalog. */
- apps: AppConnection;
- /** A globally-unique ID. */
- id: Scalars['ID']['output'];
- /** Most recent catalog operations. */
- operations: Array;
- /** The price list associated with the catalog. */
- priceList?: Maybe;
- /** A group of products and collections that's published to a catalog. */
- publication?: Maybe;
- /** The status of the catalog. */
- status: CatalogStatus;
- /** The name of the catalog. */
- title: Scalars['String']['output'];
-};
-
+export type AppCatalog = Catalog &
+ Node & {
+ __typename?: "AppCatalog"
+ /** The apps associated with the catalog. */
+ apps: AppConnection
+ /** A globally-unique ID. */
+ id: Scalars["ID"]["output"]
+ /** Most recent catalog operations. */
+ operations: Array
+ /** The price list associated with the catalog. */
+ priceList?: Maybe
+ /** A group of products and collections that's published to a catalog. */
+ publication?: Maybe
+ /** The status of the catalog. */
+ status: CatalogStatus
+ /** The name of the catalog. */
+ title: Scalars["String"]["output"]
+ }
/**
* A catalog that defines the publication associated with an app.
*
*/
export type AppCatalogAppsArgs = {
- after?: InputMaybe;
- before?: InputMaybe;
- first?: InputMaybe;
- last?: InputMaybe;
- reverse?: InputMaybe;
-};
+ after?: InputMaybe
+ before?: InputMaybe
+ first?: InputMaybe
+ last?: InputMaybe
+ reverse?: InputMaybe
+}
/**
* An auto-generated type for paginating through multiple Apps.
*
*/
export type AppConnection = {
- __typename?: 'AppConnection';
+ __typename?: "AppConnection"
/** A list of edges. */
- edges: Array;
+ edges: Array
/** A list of the nodes contained in AppEdge. */
- nodes: Array;
+ nodes: Array
/** Information to aid in pagination. */
- pageInfo: PageInfo;
-};
+ pageInfo: PageInfo
+}
/** App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify. */
export type AppCredit = Node & {
- __typename?: 'AppCredit';
+ __typename?: "AppCredit"
/** The amount that can be used towards future app purchases in Shopify. */
- amount: MoneyV2;
+ amount: MoneyV2
/** The date and time when the app credit was created. */
- createdAt: Scalars['DateTime']['output'];
+ createdAt: Scalars["DateTime"]["output"]
/** The description of the app credit. */
- description: Scalars['String']['output'];
+ description: Scalars["String"]["output"]
/** A globally-unique ID. */
- id: Scalars['ID']['output'];
+ id: Scalars["ID"]["output"]
/** Whether the app credit is a test transaction. */
- test: Scalars['Boolean']['output'];
-};
+ test: Scalars["Boolean"]["output"]
+}
/**
* An auto-generated type for paginating through multiple AppCredits.
*
*/
export type AppCreditConnection = {
- __typename?: 'AppCreditConnection';
+ __typename?: "AppCreditConnection"
/** A list of edges. */
- edges: Array;
+ edges: Array
/** A list of the nodes contained in AppCreditEdge. */
- nodes: Array;
+ nodes: Array
/** Information to aid in pagination. */
- pageInfo: PageInfo;
-};
+ pageInfo: PageInfo
+}
/**
* An auto-generated type which holds one AppCredit and a cursor during pagination.
*
*/
export type AppCreditEdge = {
- __typename?: 'AppCreditEdge';
+ __typename?: "AppCreditEdge"
/** A cursor for use in pagination. */
- cursor: Scalars['String']['output'];
+ cursor: Scalars["String"]["output"]
/** The item at the end of AppCreditEdge. */
- node: AppCredit;
-};
+ node: AppCredit
+}
/** Possible types of app developer. */
export enum AppDeveloperType {
/** Indicates the app developer works directly for a Merchant. */
- Merchant = 'MERCHANT',
+ Merchant = "MERCHANT",
/** Indicates the app developer is a Partner. */
- Partner = 'PARTNER',
+ Partner = "PARTNER",
/** Indicates the app developer is Shopify. */
- Shopify = 'SHOPIFY',
+ Shopify = "SHOPIFY",
/** Indicates the app developer is unknown. It is not categorized as any of the other developer types. */
- Unknown = 'UNKNOWN'
+ Unknown = "UNKNOWN",
}
/** A script that defines a discount type. */
export type AppDiscountType = {
- __typename?: 'AppDiscountType';
+ __typename?: "AppDiscountType"
/** The app providing the app discount type. */
- app: App;
+ app: App
/** The App Bridge details for discount type configuration. */
- appBridge: FunctionsAppBridge;
+ appBridge: FunctionsAppBridge
/** The client ID of the app providing the app discount type. */
- appKey: Scalars['String']['output'];
+ appKey: Scalars["String"]["output"]
/** A description of the app discount type. */
- description?: Maybe;
+ description?: Maybe
/** The class of the app discount type. */
- discountClass: DiscountClass;
+ discountClass: DiscountClass
/** The ID of the function providing the app discount type. */
- functionId: Scalars['String']['output'];
+ functionId: Scalars["String"]["output"]
/** The target type of the app discount type. Possible values: `SHIPPING_LINE` and `LINE_ITEM`. */
- targetType: DiscountApplicationTargetType;
+ targetType: DiscountApplicationTargetType
/** The title of the app discount type. */
- title: Scalars['String']['output'];
-};
+ title: Scalars["String"]["output"]
+}
/**
* An auto-generated type which holds one App and a cursor during pagination.
*
*/
export type AppEdge = {
- __typename?: 'AppEdge';
+ __typename?: "AppEdge"
/** A cursor for use in pagination. */
- cursor: Scalars['String']['output'];
+ cursor: Scalars["String"]["output"]
/** The item at the end of AppEdge. */
- node: App;
-};
+ node: App
+}
/**
* Reports the status of shops and their resources and displays this information
@@ -656,150 +655,143 @@ export type AppEdge = {
*
*/
export type AppFeedback = {
- __typename?: 'AppFeedback';
+ __typename?: "AppFeedback"
/** The application associated to the feedback. */
- app: App;
+ app: App
/** A link to where merchants can resolve errors. */
- link?: Maybe;
+ link?: Maybe
/** The feedback message presented to the merchant. */
- messages: Array;
-};
+ messages: Array
+}
/** Represents an installed application on a shop. */
-export type AppInstallation = HasMetafields & Node & {
- __typename?: 'AppInstallation';
- /** The access scopes granted to the application by a merchant during installation. */
- accessScopes: Array;
- /** The active application subscriptions billed to the shop on a recurring basis. */
- activeSubscriptions: Array;
- /** All subscriptions created for a shop. */
- allSubscriptions: AppSubscriptionConnection;
- /** Application which is installed. */
- app: App;
- /**
- * Channel associated with the installed application.
- * @deprecated Use `publication` instead.
- */
- channel?: Maybe;
- /** Credits that can be used towards future app purchases. */
- credits: AppCreditConnection;
- /** A globally-unique ID. */
- id: Scalars['ID']['output'];
- /** The URL to launch the application. */
- launchUrl: Scalars['URL']['output'];
- /** Returns a metafield by namespace and key that belongs to the resource. */
- metafield?: Maybe;
- /** List of metafields that belong to the resource. */
- metafields: MetafieldConnection;
- /** One-time purchases to a shop. */
- oneTimePurchases: AppPurchaseOneTimeConnection;
- /**
- * Returns a private metafield by namespace and key that belongs to the resource.
- * @deprecated Metafields created using a reserved namespace are private by default. See our guide for
- * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).
- *
- */
- privateMetafield?: Maybe;
- /**
- * List of private metafields that belong to the resource.
- * @deprecated Metafields created using a reserved namespace are private by default. See our guide for
- * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).
- *
- */
- privateMetafields: PrivateMetafieldConnection;
- /** The publication associated with the installed application. */
- publication?: Maybe;
- /** The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes. */
- revenueAttributionRecords: AppRevenueAttributionRecordConnection;
- /**
- * Subscriptions charge to a shop on a recurring basis.
- * @deprecated Use `activeSubscriptions` instead.
- */
- subscriptions: Array;
- /** The URL to uninstall the application. */
- uninstallUrl?: Maybe;
-};
-
+export type AppInstallation = HasMetafields &
+ Node & {
+ __typename?: "AppInstallation"
+ /** The access scopes granted to the application by a merchant during installation. */
+ accessScopes: Array
+ /** The active application subscriptions billed to the shop on a recurring basis. */
+ activeSubscriptions: Array
+ /** All subscriptions created for a shop. */
+ allSubscriptions: AppSubscriptionConnection
+ /** Application which is installed. */
+ app: App
+ /**
+ * Channel associated with the installed application.
+ * @deprecated Use `publication` instead.
+ */
+ channel?: Maybe
+ /** Credits that can be used towards future app purchases. */
+ credits: AppCreditConnection
+ /** A globally-unique ID. */
+ id: Scalars["ID"]["output"]
+ /** The URL to launch the application. */
+ launchUrl: Scalars["URL"]["output"]
+ /** Returns a metafield by namespace and key that belongs to the resource. */
+ metafield?: Maybe
+ /** List of metafields that belong to the resource. */
+ metafields: MetafieldConnection
+ /** One-time purchases to a shop. */
+ oneTimePurchases: AppPurchaseOneTimeConnection
+ /**
+ * Returns a private metafield by namespace and key that belongs to the resource.
+ * @deprecated Metafields created using a reserved namespace are private by default. See our guide for
+ * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).
+ *
+ */
+ privateMetafield?: Maybe
+ /**
+ * List of private metafields that belong to the resource.
+ * @deprecated Metafields created using a reserved namespace are private by default. See our guide for
+ * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).
+ *
+ */
+ privateMetafields: PrivateMetafieldConnection
+ /** The publication associated with the installed application. */
+ publication?: Maybe
+ /** The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes. */
+ revenueAttributionRecords: AppRevenueAttributionRecordConnection
+ /**
+ * Subscriptions charge to a shop on a recurring basis.
+ * @deprecated Use `activeSubscriptions` instead.
+ */
+ subscriptions: Array
+ /** The URL to uninstall the application. */
+ uninstallUrl?: Maybe
+ }
/** Represents an installed application on a shop. */
export type AppInstallationAllSubscriptionsArgs = {
- after?: InputMaybe;
- before?: InputMaybe;
- first?: InputMaybe;
- last?: InputMaybe;
- reverse?: InputMaybe;
- sortKey?: InputMaybe;
-};
-
+ after?: InputMaybe
+ before?: InputMaybe
+ first?: InputMaybe
+ last?: InputMaybe
+ reverse?: InputMaybe
+ sortKey?: InputMaybe
+}
/** Represents an installed application on a shop. */
export type AppInstallationCreditsArgs = {
- after?: InputMaybe;
- before?: InputMaybe;
- first?: InputMaybe;
- last?: InputMaybe;
- reverse?: InputMaybe;
- sortKey?: InputMaybe;
-};
-
+ after?: InputMaybe
+ before?: InputMaybe
+ first?: InputMaybe
+ last?: InputMaybe
+ reverse?: InputMaybe
+ sortKey?: InputMaybe
+}
/** Represents an installed application on a shop. */
export type AppInstallationMetafieldArgs = {
- key: Scalars['String']['input'];
- namespace?: InputMaybe;
-};
-
+ key: Scalars["String"]["input"]
+ namespace?: InputMaybe
+}
/** Represents an installed application on a shop. */
export type AppInstallationMetafieldsArgs = {
- after?: InputMaybe;
- before?: InputMaybe;
- first?: InputMaybe;
- keys?: InputMaybe>;
- last?: InputMaybe;
- namespace?: InputMaybe;
- reverse?: InputMaybe;
-};
-
+ after?: InputMaybe
+ before?: InputMaybe
+ first?: InputMaybe
+ keys?: InputMaybe