From d242dc9ecb277fd68b2379979201b187daaa813d Mon Sep 17 00:00:00 2001 From: Clement Date: Fri, 4 Oct 2024 11:43:24 +1000 Subject: [PATCH] Updated Wish.GraphQLSchemaGenerator dependency and regenerated graphql schema file --- Directory.Packages.props | 4 +- .../GraphQL/GraphQLSchema.generated.cs | 2202 ++++++++++------- 2 files changed, 1293 insertions(+), 913 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 9bf3d594e..e56f9a400 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -24,6 +24,6 @@ - + - + \ No newline at end of file diff --git a/ShopifySharp/Entities/GraphQL/GraphQLSchema.generated.cs b/ShopifySharp/Entities/GraphQL/GraphQLSchema.generated.cs index b2e5df397..52045c7a8 100644 --- a/ShopifySharp/Entities/GraphQL/GraphQLSchema.generated.cs +++ b/ShopifySharp/Entities/GraphQL/GraphQLSchema.generated.cs @@ -91,7 +91,7 @@ public class AbandonedCheckout : GraphQLObject, INavigable, I /// public string? abandonedCheckoutUrl { get; set; } /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// @@ -102,9 +102,11 @@ public class AbandonedCheckout : GraphQLObject, INavigable, I ///A list of the line items in this checkout. /// public AbandonedCheckoutLineItemConnection? lineItems { get; set; } + /// ///The number of products in the checkout. /// + [Obsolete("Use [AbandonedCheckoutLineItem.quantity](https://shopify.dev/api/admin-graphql/unstable/objects/AbandonedCheckoutLineItem#field-quantity) instead.")] public int? lineItemsQuantity { get; set; } /// ///The sum of all items in the checkout, including discounts, shipping, taxes, and tips. @@ -189,15 +191,15 @@ public class AbandonedCheckoutLineItem : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AbandonedCheckoutLineItemEdge. + ///A list of nodes that are contained in AbandonedCheckoutLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -208,7 +210,7 @@ public class AbandonedCheckoutLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -726,7 +728,7 @@ public class App : GraphQLObject, INode /// public string? appStoreDeveloperUrl { get; set; } /// - ///The access scopes available to the app. + ///All requestable access scopes available to the app. /// public IEnumerable? availableAccessScopes { get; set; } /// @@ -829,7 +831,7 @@ public class App : GraphQLObject, INode /// public bool? published { get; set; } /// - ///The access scopes requested by the app. + ///The access scopes requested by the app. Lists the access scopes the app has declared in its configuration. Merchant must grant approval to these scopes for the app to be installed. /// public IEnumerable? requestedAccessScopes { get; set; } /// @@ -902,15 +904,15 @@ public class AppCatalog : GraphQLObject, ICatalog, INode public class AppConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AppEdge. + ///A list of nodes that are contained in AppEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -948,15 +950,15 @@ public class AppCredit : GraphQLObject, INode public class AppCreditConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AppCreditEdge. + ///A list of nodes that are contained in AppCreditEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -967,7 +969,7 @@ public class AppCreditConnection : GraphQLObject, IConnecti public class AppCreditEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -1044,7 +1046,7 @@ public class AppDiscountType : GraphQLObject public class AppEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -1114,11 +1116,14 @@ public class AppInstallation : GraphQLObject, IHasMetafields, I /// public string? launchUrl { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -1179,15 +1184,15 @@ public enum AppInstallationCategory public class AppInstallationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AppInstallationEdge. + ///A list of nodes that are contained in AppInstallationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -1198,7 +1203,7 @@ public class AppInstallationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -1373,15 +1378,15 @@ public class AppPurchaseOneTime : GraphQLObject, IAppPurchas public class AppPurchaseOneTimeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AppPurchaseOneTimeEdge. + ///A list of nodes that are contained in AppPurchaseOneTimeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -1416,7 +1421,7 @@ public class AppPurchaseOneTimeCreatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -1523,15 +1528,15 @@ public class AppRevenueAttributionRecord : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AppRevenueAttributionRecordEdge. + ///A list of nodes that are contained in AppRevenueAttributionRecordEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -1542,7 +1547,7 @@ public class AppRevenueAttributionRecordConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -1658,15 +1663,15 @@ public class AppSubscriptionCancelPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AppSubscriptionEdge. + ///A list of nodes that are contained in AppSubscriptionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -1754,7 +1759,7 @@ public interface IAppSubscriptionDiscountValue : IGraphQLObject public class AppSubscriptionEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -2018,15 +2023,15 @@ public class AppUsageRecord : GraphQLObject, INode public class AppUsageRecordConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in AppUsageRecordEdge. + ///A list of nodes that are contained in AppUsageRecordEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -2052,7 +2057,7 @@ public class AppUsageRecordCreatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -2113,16 +2118,16 @@ public class AppleApplication : GraphQLObject, IMobilePlatform } /// - ///Represents a generic custom attribute. + ///Represents a generic custom attribute, such as whether an order is a customer's first. /// public class Attribute : GraphQLObject { /// - ///Key or name of the attribute. + ///The key or name of the attribute. For example, `"customersFirstOrder"`. /// public string? key { get; set; } /// - ///Value of the attribute. + ///The value of the attribute. For example, `"true"`. /// public string? value { get; set; } } @@ -2922,15 +2927,15 @@ public interface ICalculatedDiscountApplication : IGraphQLObject public class CalculatedDiscountApplicationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CalculatedDiscountApplicationEdge. + ///A list of nodes that are contained in CalculatedDiscountApplicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -2941,7 +2946,7 @@ public class CalculatedDiscountApplicationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -3422,15 +3427,15 @@ public class CalculatedLineItem : GraphQLObject public class CalculatedLineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CalculatedLineItemEdge. + ///A list of nodes that are contained in CalculatedLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -3441,7 +3446,7 @@ public class CalculatedLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -3718,7 +3723,7 @@ public class CalculatedShippingLine : GraphQLObject /// public string? id { get; set; } /// - ///The price of the shipping line. + ///The price of the shipping line when sold and before applying discounts. This field includes taxes if `Order.taxesIncluded` is true. Otherwise, this field doesn't include taxes for the shipping line. /// public MoneyBag? price { get; set; } /// @@ -3974,11 +3979,14 @@ public class CartTransform : GraphQLObject, IHasMetafields, INode /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -4001,15 +4009,15 @@ public class CartTransform : GraphQLObject, IHasMetafields, INode public class CartTransformConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CartTransformEdge. + ///A list of nodes that are contained in CartTransformEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -4126,7 +4134,7 @@ public enum CartTransformDeleteUserErrorCode public class CartTransformEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -4198,15 +4206,15 @@ public class CashTrackingAdjustment : GraphQLObject, INo public class CashTrackingAdjustmentConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CashTrackingAdjustmentEdge. + ///A list of nodes that are contained in CashTrackingAdjustmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -4217,7 +4225,7 @@ public class CashTrackingAdjustmentConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -4327,15 +4335,15 @@ public class CashTrackingSession : GraphQLObject, INode public class CashTrackingSessionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CashTrackingSessionEdge. + ///A list of nodes that are contained in CashTrackingSessionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -4346,7 +4354,7 @@ public class CashTrackingSessionConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -4453,15 +4461,15 @@ public interface ICatalog : IGraphQLObject, INode public class CatalogConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CatalogEdge. + ///A list of nodes that are contained in CatalogEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -4540,7 +4548,7 @@ public class CatalogDeletePayload : GraphQLObject public class CatalogEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -4874,15 +4882,15 @@ public class Channel : GraphQLObject, INode public class ChannelConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ChannelEdge. + ///A list of nodes that are contained in ChannelEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -4925,7 +4933,7 @@ public class ChannelDefinition : GraphQLObject, INode public class ChannelEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -5222,28 +5230,28 @@ public class CheckoutBrandingColorGlobal : GraphQLObject public string? accent { get; set; } /// - ///A color strongly associated with the merchant, currently used for elements - ///like primary and secondary buttons. + ///A color that's strongly associated with the merchant. Currently used for + ///primary buttons, for example **Pay now**, and secondary buttons, for example **Buy again**. /// public string? brand { get; set; } /// - ///A semantic color used for components that communicate critical content. + ///A semantic color used for components that communicate critical content. For example, a blocking error such as the requirement to enter a valid credit card number. /// public string? critical { get; set; } /// - ///A color used to highlight certain areas of the user interface. + ///A color used to highlight certain areas of the user interface. For example, the [`Text`](https://shopify.dev/docs/api/checkout-ui-extensions/latest/components/titles-and-text/text#textprops-propertydetail-appearance) component. /// public string? decorative { get; set; } /// - ///A semantic color used for components that communicate informative content. + ///A semantic color used for components that communicate general, informative content. /// public string? info { get; set; } /// - ///A semantic color used for components that communicate successful actions. + ///A semantic color used for components that communicate successful actions or a positive state. /// public string? success { get; set; } /// - ///A semantic color used for components that display content that requires attention. + ///A semantic color used for components that display content that requires attention. For example, something that might be wrong, but not blocking. /// public string? warning { get; set; } } @@ -5280,25 +5288,25 @@ public class CheckoutBrandingColorRoles : GraphQLObject - ///A base set of color customizations that is applied to an area of Checkout, from which every component - ///pulls its colors from. + ///A base set of color customizations that's applied to an area of Checkout, from which every component + ///pulls its colors. /// public class CheckoutBrandingColorScheme : GraphQLObject { /// - ///The main colors of a scheme. + ///The main colors of a scheme. Used for the surface background, text, links, and more. /// public CheckoutBrandingColorRoles? @base { get; set; } /// - ///The colors of form controls. + ///The colors of form controls, such as the [`TextField`](https://shopify.dev/docs/api/checkout-ui-extensions/latest/components/forms/textfield) and [`ChoiceList`](https://shopify.dev/docs/api/checkout-ui-extensions/latest/components/forms/choicelist) components. /// public CheckoutBrandingControlColorRoles? control { get; set; } /// - ///The colors of the primary button. + ///The colors of the primary button. For example, the main payment, or **Pay now** button. /// public CheckoutBrandingButtonColorRoles? primaryButton { get; set; } /// - ///The colors of the secondary button. + ///The colors of the secondary button, which is used for secondary actions. For example, **Buy again**. /// public CheckoutBrandingButtonColorRoles? secondaryButton { get; set; } } @@ -6629,15 +6637,15 @@ public class CheckoutProfile : GraphQLObject, INode public class CheckoutProfileConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CheckoutProfileEdge. + ///A list of nodes that are contained in CheckoutProfileEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -6648,7 +6656,7 @@ public class CheckoutProfileConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -6735,7 +6743,10 @@ public enum CodeDiscountSortKeys public class Collection : GraphQLObject, IHasMetafieldDefinitions, IHasMetafields, IHasPublishedTranslations, INode, IPublishable, IMetafieldReference, IMetafieldReferencer { /// - ///The number of publications a resource is published to without feedback errors. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// public Count? availablePublicationsCount { get; set; } /// @@ -6775,15 +6786,20 @@ public class Collection : GraphQLObject, IHasMetafieldDefinitions, I /// public ulong? legacyResourceId { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -6808,7 +6824,10 @@ public class Collection : GraphQLObject, IHasMetafieldDefinitions, I public Count? productsCount { get; set; } /// - ///The number of publications a resource is published on. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// [Obsolete("Use `resourcePublicationsCount` instead.")] public int? publicationCount { get; set; } @@ -6820,34 +6839,44 @@ public class Collection : GraphQLObject, IHasMetafieldDefinitions, I public CollectionPublicationConnection? publications { get; set; } /// - ///Check to see whether the resource is published to a given channel. + ///Whether the resource is published to a specific channel. /// [Obsolete("Use `publishedOnPublication` instead.")] public bool? publishedOnChannel { get; set; } /// - ///Check to see whether the resource is published to the calling app's channel. + ///Whether the resource is published to a + ///[channel](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel). + ///For example, the resource might be published to the online store channel. /// [Obsolete("Use `publishedOnCurrentPublication` instead.")] public bool? publishedOnCurrentChannel { get; set; } /// - ///Check to see whether the resource is published to the calling app's publication. + ///Whether the resource is published to the app's + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). + ///For example, the resource might be published to the app's online store channel. /// public bool? publishedOnCurrentPublication { get; set; } /// - ///Check to see whether the resource is published to a given publication. + ///Whether the resource is published to a specified + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public bool? publishedOnPublication { get; set; } /// - ///The list of resources that are published to a publication. + ///The list of resources that are published to a + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public ResourcePublicationConnection? resourcePublications { get; set; } /// - ///The number of publications a resource is published on. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// public Count? resourcePublicationsCount { get; set; } /// - ///The list of resources that are either published or staged to be published to a publication. + ///The list of resources that are either published or staged to be published to a + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public ResourcePublicationV2Connection? resourcePublicationsV2 { get; set; } /// @@ -6879,7 +6908,7 @@ public class Collection : GraphQLObject, IHasMetafieldDefinitions, I /// public string? title { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } @@ -6889,7 +6918,8 @@ public class Collection : GraphQLObject, IHasMetafieldDefinitions, I [Obsolete("Use `unpublishedPublications` instead.")] public ChannelConnection? unpublishedChannels { get; set; } /// - ///The list of publications that the resource is not published to. + ///The list of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that the resource isn't published to. /// public PublicationConnection? unpublishedPublications { get; set; } /// @@ -6968,15 +6998,15 @@ public enum CollectionAddProductsV2UserErrorCode public class CollectionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CollectionEdge. + ///A list of nodes that are contained in CollectionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -7021,7 +7051,7 @@ public class CollectionDeletePayload : GraphQLObject public class CollectionEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -7064,15 +7094,15 @@ public class CollectionPublication : GraphQLObject public class CollectionPublicationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CollectionPublicationEdge. + ///A list of nodes that are contained in CollectionPublicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -7083,7 +7113,7 @@ public class CollectionPublicationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -7514,15 +7544,15 @@ public class CombinedListingChild : GraphQLObject public class CombinedListingChildConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CombinedListingChildEdge. + ///A list of nodes that are contained in CombinedListingChildEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -7533,7 +7563,7 @@ public class CombinedListingChildConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -7838,11 +7868,14 @@ public interface ICommentEventEmbed : IGraphQLObject /// public ulong? legacyResourceId { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -7909,7 +7942,7 @@ public class CompaniesDeletePayload : GraphQLObject /// ///Represents information about a company which is also a customer of the shop. /// - public class Company : GraphQLObject, ICommentEventSubject, IHasEvents, IHasMetafieldDefinitions, IHasMetafields, INavigable, INode, IMetafieldReferencer + public class Company : GraphQLObject, ICommentEventSubject, IHasEvents, IHasMetafieldDefinitions, IHasMetafields, INavigable, INode, IMetafieldReference, IMetafieldReferencer { /// ///The number of contacts that belong to the company. @@ -7937,7 +7970,7 @@ public class Company : GraphQLObject, ICommentEventSubject, IHasEvents, /// public DateTime? customerSince { get; set; } /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// @@ -7981,15 +8014,20 @@ public class Company : GraphQLObject, ICommentEventSubject, IHasEvents, /// public CompanyContact? mainContact { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -8178,15 +8216,15 @@ public class CompanyAssignMainContactPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CompanyEdge. + ///A list of nodes that are contained in CompanyEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -8282,15 +8320,15 @@ public class CompanyContactAssignRolesPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CompanyContactEdge. + ///A list of nodes that are contained in CompanyContactEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -8331,7 +8369,7 @@ public class CompanyContactDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -8446,15 +8484,15 @@ public class CompanyContactRoleAssignment : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CompanyContactRoleAssignmentEdge. + ///A list of nodes that are contained in CompanyContactRoleAssignmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -8465,7 +8503,7 @@ public class CompanyContactRoleAssignmentConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -8508,15 +8546,15 @@ public enum CompanyContactRoleAssignmentSortKeys public class CompanyContactRoleConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CompanyContactRoleEdge. + ///A list of nodes that are contained in CompanyContactRoleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -8527,7 +8565,7 @@ public class CompanyContactRoleConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -8685,7 +8723,7 @@ public class CompanyDeletePayload : GraphQLObject public class CompanyEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -8712,7 +8750,7 @@ public class CompanyLocation : GraphQLObject, ICommentEventSubj /// public CatalogConnection? catalogs { get; set; } /// - ///The number of catalogs associated with the company location. + ///The number of catalogs associated with the company location. Limited to a maximum of 10000. /// public Count? catalogsCount { get; set; } /// @@ -8728,7 +8766,7 @@ public class CompanyLocation : GraphQLObject, ICommentEventSubj /// public CurrencyCode? currency { get; set; } /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// @@ -8764,15 +8802,20 @@ public class CompanyLocation : GraphQLObject, ICommentEventSubj /// public Market? market { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -8929,15 +8972,15 @@ public class CompanyLocationCatalog : GraphQLObject, ICa public class CompanyLocationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CompanyLocationEdge. + ///A list of nodes that are contained in CompanyLocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -8993,7 +9036,7 @@ public class CompanyLocationDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -9193,7 +9236,7 @@ public class Count : GraphQLObject /// public int? count { get; set; } /// - ///The count's precision, or how exact the value is. + ///The count's precision, or the exactness of the value. /// public CountPrecision? precision { get; set; } } @@ -10239,15 +10282,15 @@ public class CountryHarmonizedSystemCode : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CountryHarmonizedSystemCodeEdge. + ///A list of nodes that are contained in CountryHarmonizedSystemCodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -10258,7 +10301,7 @@ public class CountryHarmonizedSystemCodeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -11001,15 +11044,15 @@ public class CurrencySetting : GraphQLObject public class CurrencySettingConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CurrencySettingEdge. + ///A list of nodes that are contained in CurrencySettingEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -11020,7 +11063,7 @@ public class CurrencySettingConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -11035,7 +11078,7 @@ public class CurrencySettingEdge : GraphQLObject, IEdge - public class Customer : GraphQLObject, ICommentEventSubject, IHasEvents, IHasMetafieldDefinitions, IHasMetafields, IHasStoreCreditAccounts, ILegacyInteroperability, INode, ICommentEventEmbed, IMetafieldReferencer, IPurchasingEntity + public class Customer : GraphQLObject, ICommentEventSubject, IHasEvents, IHasMetafieldDefinitions, IHasMetafields, IHasStoreCreditAccounts, ILegacyInteroperability, INode, ICommentEventEmbed, IMetafieldReference, IMetafieldReferencer, IPurchasingEntity { /// ///A list of addresses associated with the customer. @@ -11135,15 +11178,20 @@ public class Customer : GraphQLObject, ICommentEventSubject, IHasEvent /// public CustomerMergeable? mergeable { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -11194,6 +11242,8 @@ public class Customer : GraphQLObject, ICommentEventSubject, IHasEvent public CustomerSmsMarketingConsentState? smsMarketingConsent { get; set; } /// ///The state of the customer's account with the shop. + /// + ///Please note that this only meaningful when Classic Customer Accounts is active. /// public CustomerState? state { get; set; } /// @@ -11354,15 +11404,15 @@ public class CustomerCancelDataErasureUserError : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CustomerEdge. + ///A list of nodes that are contained in CustomerEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -11522,7 +11572,7 @@ public class CustomerDeletePayload : GraphQLObject public class CustomerEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -12183,15 +12233,15 @@ public interface ICustomerMoment : IGraphQLObject public class CustomerMomentConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CustomerMomentEdge. + ///A list of nodes that are contained in CustomerMomentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -12202,7 +12252,7 @@ public class CustomerMomentConnection : GraphQLObject, public class CustomerMomentEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -12307,15 +12357,15 @@ public class CustomerPaymentMethod : GraphQLObject, INode public class CustomerPaymentMethodConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CustomerPaymentMethodEdge. + ///A list of nodes that are contained in CustomerPaymentMethodEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -12417,7 +12467,7 @@ public class CustomerPaymentMethodCreditCardUpdatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -13026,11 +13076,14 @@ public class CustomerSegmentMember : GraphQLObject, IHasM /// public CustomerMergeable? mergeable { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -13065,7 +13118,7 @@ public class CustomerSegmentMemberConnection : GraphQLObject public IEnumerable? edges { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } /// @@ -13084,7 +13137,7 @@ public class CustomerSegmentMemberConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -13491,15 +13544,15 @@ public class CustomerVisitProductInfo : GraphQLObject public class CustomerVisitProductInfoConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in CustomerVisitProductInfoEdge. + ///A list of nodes that are contained in CustomerVisitProductInfoEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -13510,7 +13563,7 @@ public class CustomerVisitProductInfoConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -13603,8 +13656,7 @@ public enum DayOfTheWeek ///A token that delegates a set of scopes from the original permission. /// ///To learn more about creating delegate access tokens, refer to - ///[Delegate OAuth access tokens to subsystems] - ///(https://shopify.dev/apps/auth/oauth/delegate-access-tokens). + ///[Delegate OAuth access tokens to subsystems](https://shopify.dev/docs/apps/build/authentication-authorization/access-tokens/use-delegate-tokens). /// public class DelegateAccessToken : GraphQLObject { @@ -13783,15 +13835,15 @@ public class DeletionEvent : GraphQLObject public class DeletionEventConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DeletionEventEdge. + ///A list of nodes that are contained in DeletionEventEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -13802,7 +13854,7 @@ public class DeletionEventConnection : GraphQLObject, I public class DeletionEventEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -14091,15 +14143,15 @@ public class DeliveryCarrierServiceAndLocations : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DeliveryCarrierServiceEdge. + ///A list of nodes that are contained in DeliveryCarrierServiceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -14110,7 +14162,7 @@ public class DeliveryCarrierServiceConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -14281,15 +14333,20 @@ public class DeliveryCustomization : GraphQLObject, IHasM /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -14335,15 +14392,15 @@ public class DeliveryCustomizationActivationPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DeliveryCustomizationEdge. + ///A list of nodes that are contained in DeliveryCustomizationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -14384,7 +14441,7 @@ public class DeliveryCustomizationDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -14604,15 +14661,15 @@ public class DeliveryLocationGroupZone : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DeliveryLocationGroupZoneEdge. + ///A list of nodes that are contained in DeliveryLocationGroupZoneEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -14623,7 +14680,7 @@ public class DeliveryLocationGroupZoneConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -14758,15 +14815,15 @@ public class DeliveryMethodDefinition : GraphQLObject, public class DeliveryMethodDefinitionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DeliveryMethodDefinitionEdge. + ///A list of nodes that are contained in DeliveryMethodDefinitionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -14792,7 +14849,7 @@ public class DeliveryMethodDefinitionCounts : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -14830,11 +14887,11 @@ public enum DeliveryMethodType /// PICK_UP, /// - ///No delivery is needed. + ///Non-physical items, no delivery needed. /// NONE, /// - ///The order is delivered to a retail store. + ///In-store sale, no delivery needed. /// RETAIL, /// @@ -14910,7 +14967,7 @@ public class DeliveryProductVariantsCount : GraphQLObject - ///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. + ///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. Learn more about [building with delivery profiles](https://shopify.dev/apps/build/purchase-options/deferred/delivery-and-deferment/build-delivery-profiles). /// public class DeliveryProfile : GraphQLObject, INode { @@ -14984,15 +15041,15 @@ public class DeliveryProfile : GraphQLObject, INode public class DeliveryProfileConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DeliveryProfileEdge. + ///A list of nodes that are contained in DeliveryProfileEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -15018,7 +15075,7 @@ public class DeliveryProfileCreatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -15052,15 +15109,15 @@ public class DeliveryProfileItem : GraphQLObject, INode public class DeliveryProfileItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DeliveryProfileItemEdge. + ///A list of nodes that are contained in DeliveryProfileItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -15071,7 +15128,7 @@ public class DeliveryProfileItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -15509,15 +15566,15 @@ public enum DiscountApplicationAllocationMethod public class DiscountApplicationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DiscountApplicationEdge. + ///A list of nodes that are contained in DiscountApplicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -15528,7 +15585,7 @@ public class DiscountApplicationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -15964,15 +16021,15 @@ public class DiscountAutomaticBxgyUpdatePayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DiscountAutomaticEdge. + ///A list of nodes that are contained in DiscountAutomaticEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -16013,7 +16070,7 @@ public class DiscountAutomaticDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -16153,15 +16210,20 @@ public class DiscountAutomaticNode : GraphQLObject, IHasE /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -16184,15 +16246,15 @@ public class DiscountAutomaticNode : GraphQLObject, IHasE public class DiscountAutomaticNodeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DiscountAutomaticNodeEdge. + ///A list of nodes that are contained in DiscountAutomaticNodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -16203,7 +16265,7 @@ public class DiscountAutomaticNodeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -16958,15 +17020,20 @@ public class DiscountCodeNode : GraphQLObject, IHasEvents, IHa /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -16989,15 +17056,15 @@ public class DiscountCodeNode : GraphQLObject, IHasEvents, IHa public class DiscountCodeNodeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DiscountCodeNodeEdge. + ///A list of nodes that are contained in DiscountCodeNodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -17008,7 +17075,7 @@ public class DiscountCodeNodeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -17408,15 +17475,20 @@ public class DiscountNode : GraphQLObject, IHasEvents, IHasMetafie /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -17439,15 +17511,15 @@ public class DiscountNode : GraphQLObject, IHasEvents, IHasMetafie public class DiscountNodeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DiscountNodeEdge. + ///A list of nodes that are contained in DiscountNodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -17458,7 +17530,7 @@ public class DiscountNodeConnection : GraphQLObject, ICo public class DiscountNodeEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -17634,15 +17706,15 @@ public class DiscountRedeemCodeBulkCreationCode : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DiscountRedeemCodeBulkCreationCodeEdge. + ///A list of nodes that are contained in DiscountRedeemCodeBulkCreationCodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -17653,7 +17725,7 @@ public class DiscountRedeemCodeBulkCreationCodeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -17668,15 +17740,15 @@ public class DiscountRedeemCodeBulkCreationCodeEdge : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DiscountRedeemCodeEdge. + ///A list of nodes that are contained in DiscountRedeemCodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -17687,7 +17759,7 @@ public class DiscountRedeemCodeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -17977,7 +18049,6 @@ public class DiscountUserError : GraphQLObject, IDisplayableE [JsonDerivedType(typeof(ProductVariantsBulkDeleteUserError), typeDiscriminator: "ProductVariantsBulkDeleteUserError")] [JsonDerivedType(typeof(ProductVariantsBulkReorderUserError), typeDiscriminator: "ProductVariantsBulkReorderUserError")] [JsonDerivedType(typeof(ProductVariantsBulkUpdateUserError), typeDiscriminator: "ProductVariantsBulkUpdateUserError")] - [JsonDerivedType(typeof(ProductVariantsBulkUpdateUserError), typeDiscriminator: "ProductVariantsBulkUpdateUserError")] [JsonDerivedType(typeof(PubSubWebhookSubscriptionCreateUserError), typeDiscriminator: "PubSubWebhookSubscriptionCreateUserError")] [JsonDerivedType(typeof(PubSubWebhookSubscriptionUpdateUserError), typeDiscriminator: "PubSubWebhookSubscriptionUpdateUserError")] [JsonDerivedType(typeof(PublicationUserError), typeDiscriminator: "PublicationUserError")] @@ -18367,7 +18438,7 @@ public class DraftOrder : GraphQLObject, ICommentEventSubject, IHasE /// public Customer? customer { get; set; } /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// @@ -18428,11 +18499,14 @@ public class DraftOrder : GraphQLObject, ICommentEventSubject, IHasE /// public CountryCode? marketRegionCountryCode { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -18754,15 +18828,15 @@ public class DraftOrderCompletePayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DraftOrderEdge. + ///A list of nodes that are contained in DraftOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -18875,7 +18949,7 @@ public class DraftOrderDuplicatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -19094,15 +19168,15 @@ public class DraftOrderLineItem : GraphQLObject, INode, IDra public class DraftOrderLineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in DraftOrderLineItemEdge. + ///A list of nodes that are contained in DraftOrderLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -19113,7 +19187,7 @@ public class DraftOrderLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -19613,15 +19687,15 @@ public class EventBridgeWebhookSubscriptionUpdatePayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in EventEdge. + ///A list of nodes that are contained in EventEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -19632,7 +19706,7 @@ public class EventConnection : GraphQLObject, IConnectionWithNo public class EventEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -19682,15 +19756,15 @@ public class ExchangeLineItem : GraphQLObject, INode public class ExchangeLineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ExchangeLineItemEdge. + ///A list of nodes that are contained in ExchangeLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -19701,7 +19775,7 @@ public class ExchangeLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -19794,15 +19868,15 @@ public class ExchangeV2Additions : GraphQLObject public class ExchangeV2Connection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ExchangeV2Edge. + ///A list of nodes that are contained in ExchangeV2Edge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -19813,7 +19887,7 @@ public class ExchangeV2Connection : GraphQLObject, IConnec public class ExchangeV2Edge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -20166,15 +20240,15 @@ public class FileAcknowledgeUpdateFailedPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FileEdge. + ///A list of nodes that are contained in FileEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -20261,7 +20335,7 @@ public class FileDeletePayload : GraphQLObject public class FileEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -20818,15 +20892,15 @@ public class FulfillmentCancelPayload : GraphQLObject public class FulfillmentConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FulfillmentEdge. + ///A list of nodes that are contained in FulfillmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -20845,11 +20919,14 @@ public class FulfillmentConstraintRule : GraphQLObject public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -21076,7 +21153,7 @@ public enum FulfillmentDisplayStatus public class FulfillmentEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -21150,15 +21227,15 @@ public class FulfillmentEvent : GraphQLObject, INode public class FulfillmentEventConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FulfillmentEventEdge. + ///A list of nodes that are contained in FulfillmentEventEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -21184,7 +21261,7 @@ public class FulfillmentEventCreatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -21358,15 +21435,15 @@ public class FulfillmentLineItem : GraphQLObject, INode public class FulfillmentLineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FulfillmentLineItemEdge. + ///A list of nodes that are contained in FulfillmentLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -21377,7 +21454,7 @@ public class FulfillmentLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -21490,11 +21567,11 @@ public class FulfillmentLineItemEdge : GraphQLObject, I /// ///Once a fulfillment service accepts a fulfillment request, ///then after they are ready to pack items and send them for delivery, they create fulfillments with the - ///[fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) + ///[fulfillmentCreate](https://shopify.dev/api/admin-graphql/unstable/mutations/fulfillmentCreate) ///mutation. ///They can provide tracking information right away or create fulfillments without it and then ///update the tracking information for fulfillments with the - ///[fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) + ///[fulfillmentTrackingInfoUpdate](https://shopify.dev/api/admin-graphql/unstable/mutations/fulfillmentTrackingInfoUpdate) ///mutation. /// ///[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments). @@ -21886,15 +21963,15 @@ public class FulfillmentOrderClosePayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FulfillmentOrderEdge. + ///A list of nodes that are contained in FulfillmentOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -21960,7 +22037,7 @@ public class FulfillmentOrderDestination : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -22063,11 +22140,9 @@ public class FulfillmentOrderLineItem : GraphQLObject, ///The ID of the inventory item. /// public string? inventoryItemId { get; set; } - /// ///The associated order line item. /// - [Obsolete(" As of API version 2023-01, this field has been deprecated. The order line item associated with a `FulfillmentOrderLineItem`\n shouldn't be used to determine what to fulfill. Use the `FulfillmentOrderLineItem` and `FulfillmentOrder` objects\n instead. An order `LineItem` represents a single line item on an order, but it doesn't represent what should be fulfilled.")] public LineItem? lineItem { get; set; } /// @@ -22123,15 +22198,15 @@ public class FulfillmentOrderLineItem : GraphQLObject, public class FulfillmentOrderLineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FulfillmentOrderLineItemEdge. + ///A list of nodes that are contained in FulfillmentOrderLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -22142,7 +22217,7 @@ public class FulfillmentOrderLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -22282,15 +22357,15 @@ public class FulfillmentOrderLocationForMove : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FulfillmentOrderLocationForMoveEdge. + ///A list of nodes that are contained in FulfillmentOrderLocationForMoveEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -22301,7 +22376,7 @@ public class FulfillmentOrderLocationForMoveConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -22336,7 +22411,7 @@ public class FulfillmentOrderMerchantRequest : GraphQLObject public string? requestOptions { get; set; } /// @@ -22355,15 +22430,15 @@ public class FulfillmentOrderMerchantRequest : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in FulfillmentOrderMerchantRequestEdge. + ///A list of nodes that are contained in FulfillmentOrderMerchantRequestEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -22374,7 +22449,7 @@ public class FulfillmentOrderMerchantRequestConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -23043,13 +23118,7 @@ public class FulfillmentOriginAddress : GraphQLObject ///mutation. /// ///- Shopify sends POST requests to the `/fulfillment_order_notification` endpoint - /// to notify the fulfillment service about fulfillment requests and fulfillment cancellation requests, - /// if `fulfillment_orders_opt_in` is set to `true`. - /// - /// [As of the 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation), - /// it's mandatory for a fulfillment service to follow a fulfillment order based workflow by - /// having `fulfillment_orders_opt_in` set to `true`, - /// hosting the `/fulfillment_order_notification` endpoint, and acting on fulfillment requests and cancellations. + /// to notify the fulfillment service about fulfillment requests and fulfillment cancellation requests. /// /// For more information, refer to /// [Receive fulfillment requests and cancellations](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations). @@ -23060,7 +23129,7 @@ public class FulfillmentOriginAddress : GraphQLObject /// [Enable tracking support](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-8-enable-tracking-support-optional). /// /// Fulfillment services can also update tracking information with the - /// [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation, + /// [fulfillmentTrackingInfoUpdate](https://shopify.dev/api/admin-graphql/unstable/mutations/fulfillmentTrackingInfoUpdate) mutation, /// rather than waiting for Shopify to ask for tracking numbers. ///- Shopify sends GET requests to the `/fetch_stock` endpoint to retrieve inventory levels, /// if `inventoryManagement` is set to `true`. @@ -23399,7 +23468,7 @@ public class FulfillmentTrackingInfo : GraphQLObject /// * **Norway**: Bring /// * **Poland**: Inpost /// * **Turkey**: PTT, Yurtiçi Kargo, Aras Kargo, Sürat Kargo - /// * **United States**: GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, R+L Carriers, Southwest Air Cargo + /// * **United States**: GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, Pandion, R+L Carriers, Southwest Air Cargo /// * **South Africa**: Fastway, Skynet. /// public string? company { get; set; } @@ -23546,9 +23615,11 @@ public class GiftCard : GraphQLObject, INode ///The customer who will receive the gift card. /// public Customer? customer { get; set; } + /// ///The date and time at which the gift card was disabled. /// + [Obsolete("Use `deactivatedAt` instead.")] public DateTime? disabledAt { get; set; } /// ///Whether the gift card is enabled. @@ -23590,15 +23661,15 @@ public class GiftCard : GraphQLObject, INode public class GiftCardConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in GiftCardEdge. + ///A list of nodes that are contained in GiftCardEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -23643,7 +23714,7 @@ public class GiftCardDisablePayload : GraphQLObject public class GiftCardEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -23931,6 +24002,7 @@ public interface IHasMetafieldDefinitions : IGraphQLObject /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; } } @@ -23995,11 +24067,14 @@ public interface IHasMetafields : IGraphQLObject public Shop? AsShop() => this as Shop; public Validation? AsValidation() => this as Validation; /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; } @@ -24051,7 +24126,7 @@ public interface IHasPublishedTranslations : IGraphQLObject public Shop? AsShop() => this as Shop; public ShopPolicy? AsShopPolicy() => this as ShopPolicy; /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; } } @@ -24088,11 +24163,14 @@ public class Image : GraphQLObject, IHasMetafields /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -24152,15 +24230,15 @@ public class Image : GraphQLObject, IHasMetafields public class ImageConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ImageEdge. + ///A list of nodes that are contained in ImageEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -24190,7 +24268,7 @@ public enum ImageContentType public class ImageEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -24519,6 +24597,7 @@ public class InventoryDeactivatePayload : GraphQLObject ///Represents the goods available to be shipped to a customer. ///It holds essential information about the goods, including SKU and whether it is tracked. + ///Learn [more about the relationships between inventory objects](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships). /// public class InventoryItem : GraphQLObject, ILegacyInteroperability, INode { @@ -24610,15 +24689,15 @@ public class InventoryItem : GraphQLObject, ILegacyInteroperabili public class InventoryItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in InventoryItemEdge. + ///A list of nodes that are contained in InventoryItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -24629,7 +24708,7 @@ public class InventoryItemConnection : GraphQLObject, I public class InventoryItemEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -24670,6 +24749,7 @@ public class InventoryItemUpdatePayload : GraphQLObject ///The quantities of an inventory item that are related to a specific location. + ///Learn [more about the relationships between inventory objects](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships). /// public class InventoryLevel : GraphQLObject, INode { @@ -24717,15 +24797,15 @@ public class InventoryLevel : GraphQLObject, INode public class InventoryLevelConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in InventoryLevelEdge. + ///A list of nodes that are contained in InventoryLevelEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -24736,7 +24816,7 @@ public class InventoryLevelConnection : GraphQLObject, public class InventoryLevelEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -24959,15 +25039,15 @@ public class InventoryScheduledChange : GraphQLObject public class InventoryScheduledChangeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in InventoryScheduledChangeEdge. + ///A list of nodes that are contained in InventoryScheduledChangeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -24978,7 +25058,7 @@ public class InventoryScheduledChangeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -25280,7 +25360,7 @@ public interface IJobResult : IGraphQLObject } /// - ///ISO 639-1 language codes supported by Shopify. + ///Language codes supported by Shopify. /// public enum LanguageCode { @@ -25345,6 +25425,10 @@ public enum LanguageCode /// CE, /// + ///Central Kurdish. + /// + CKB, + /// ///Czech. /// CS, @@ -25405,6 +25489,10 @@ public enum LanguageCode /// FI, /// + ///Filipino. + /// + FIL, + /// ///Faroese. /// FO, @@ -25681,6 +25769,14 @@ public enum LanguageCode /// RW, /// + ///Sanskrit. + /// + SA, + /// + ///Sardinian. + /// + SC, + /// ///Sindhi. /// SD, @@ -26164,15 +26260,15 @@ public class LineItem : GraphQLObject, INode public class LineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in LineItemEdge. + ///A list of nodes that are contained in LineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -26183,7 +26279,7 @@ public class LineItemConnection : GraphQLObject, IConnection public class LineItemEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -26414,15 +26510,15 @@ public class LineItemMutable : GraphQLObject, INode public class LineItemMutableConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in LineItemMutableEdge. + ///A list of nodes that are contained in LineItemMutableEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -26433,7 +26529,7 @@ public class LineItemMutableConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -26467,7 +26563,7 @@ public class Link : GraphQLObject, IHasPublishedTranslations /// public string? label { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } /// @@ -26616,15 +26712,15 @@ public class LocalizationExtension : GraphQLObject public class LocalizationExtensionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in LocalizationExtensionEdge. + ///A list of nodes that are contained in LocalizationExtensionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -26635,7 +26731,7 @@ public class LocalizationExtensionConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -26894,15 +26990,20 @@ public class Location : GraphQLObject, IHasMetafieldDefinitions, IHasM /// public DeliveryLocalPickupSettings? localPickupSettingsV2 { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -27162,15 +27263,15 @@ public class LocationAddress : GraphQLObject public class LocationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in LocationEdge. + ///A list of nodes that are contained in LocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -27351,7 +27452,7 @@ public enum LocationDeleteUserErrorCode public class LocationEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -27649,8 +27750,6 @@ public class MailingAddress : GraphQLObject, INode public string? name { get; set; } /// ///A unique phone number for the customer. - /// - ///Formatted using E.164 standard. For example, _+16135551111_. /// public string? phone { get; set; } /// @@ -27683,15 +27782,15 @@ public class MailingAddress : GraphQLObject, INode public class MailingAddressConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MailingAddressEdge. + ///A list of nodes that are contained in MailingAddressEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -27702,7 +27801,7 @@ public class MailingAddressConnection : GraphQLObject, public class MailingAddressEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -27804,15 +27903,20 @@ public class Market : GraphQLObject, IHasMetafieldDefinitions, IHasMetaf /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -27909,15 +28013,15 @@ public class MarketCatalog : GraphQLObject, ICatalog, INode public class MarketCatalogConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MarketCatalogEdge. + ///A list of nodes that are contained in MarketCatalogEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -27928,7 +28032,7 @@ public class MarketCatalogConnection : GraphQLObject, I public class MarketCatalogEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -27943,15 +28047,15 @@ public class MarketCatalogEdge : GraphQLObject, IEdge, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MarketEdge. + ///A list of nodes that are contained in MarketEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -28077,7 +28181,7 @@ public class MarketDeletePayload : GraphQLObject public class MarketEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -28130,15 +28234,15 @@ public class MarketLocalizableResource : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MarketLocalizableResourceEdge. + ///A list of nodes that are contained in MarketLocalizableResourceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -28149,7 +28253,7 @@ public class MarketLocalizableResourceConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -28254,15 +28358,15 @@ public interface IMarketRegion : IGraphQLObject public class MarketRegionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MarketRegionEdge. + ///A list of nodes that are contained in MarketRegionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -28315,7 +28419,7 @@ public class MarketRegionDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -28585,15 +28689,15 @@ public class MarketWebPresence : GraphQLObject, INode public class MarketWebPresenceConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MarketWebPresenceEdge. + ///A list of nodes that are contained in MarketWebPresenceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -28638,7 +28742,7 @@ public class MarketWebPresenceDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -28810,7 +28914,7 @@ public class MarketingActivity : GraphQLObject, INode /// public DateTime? updatedAt { get; set; } /// - ///A URL parameter value associated with this marketing activity. + ///The value portion of the URL query parameter used in attributing sessions to this activity. /// public string? urlParameterValue { get; set; } /// @@ -28827,15 +28931,15 @@ public class MarketingActivity : GraphQLObject, INode public class MarketingActivityConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MarketingActivityEdge. + ///A list of nodes that are contained in MarketingActivityEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -28895,7 +28999,7 @@ public class MarketingActivityDeleteExternalPayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -29372,7 +29476,7 @@ public class MarketingEngagement : GraphQLObject /// public int? impressionsCount { get; set; } /// - ///Whether the engagements are reported as lifetime totals rather than daily increments. + ///Specifies how the provided metrics have been aggregated. Cumulative metrics are aggregated from the first day of reporting up to and including `occuredOn`. Non-cumulative metrics are aggregated over the single day indicated in `occuredOn`. Cumulative metrics will monotonically increase in time as each record includes the previous day's values, and so on. Non-cumulative is strongly preferred, and support for cumulative metrics may be deprecated in the future. /// public bool? isCumulative { get; set; } /// @@ -29380,7 +29484,7 @@ public class MarketingEngagement : GraphQLObject /// public MarketingActivity? marketingActivity { get; set; } /// - ///The date that the engagements occurred on. + ///The date for which the metrics are being reported, from 0:00:00 to 23:59:59 in the time zone specified by `timeZone`. /// public DateOnly? occurredOn { get; set; } /// @@ -29556,15 +29660,15 @@ public class MarketingEvent : GraphQLObject, ILegacyInteroperabi public class MarketingEventConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MarketingEventEdge. + ///A list of nodes that are contained in MarketingEventEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -29575,7 +29679,7 @@ public class MarketingEventConnection : GraphQLObject, public class MarketingEventEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -29713,15 +29817,15 @@ public interface IMedia : IGraphQLObject public class MediaConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MediaEdge. + ///A list of nodes that are contained in MediaEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -29755,7 +29859,7 @@ public enum MediaContentType public class MediaEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -29980,11 +30084,14 @@ public class MediaImage : GraphQLObject, IFile, IHasMetafields, IMed /// public IEnumerable? mediaWarnings { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -30264,7 +30371,7 @@ public class Menu : GraphQLObject, IHasPublishedTranslations, INode /// public string? title { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } } @@ -30275,15 +30382,15 @@ public class Menu : GraphQLObject, IHasPublishedTranslations, INode public class MenuConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MenuEdge. + ///A list of nodes that are contained in MenuEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -30392,7 +30499,7 @@ public enum MenuDeleteUserErrorCode public class MenuEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -30489,6 +30596,10 @@ public enum MenuItemType ///The metaobject menu item type. /// METAOBJECT, + /// + ///The customer_account_page menu item type. + /// + CUSTOMER_ACCOUNT_PAGE, } /// @@ -30686,10 +30797,12 @@ public class MetafieldAccess : GraphQLObject ///The customer account access setting used for the metafields under this definition. /// public MetafieldCustomerAccountAccess? customerAccount { get; set; } + /// ///The explicit grants for this metafield definition, superseding the default admin access ///for the specified grantees. /// + [Obsolete("Explicit grants are [deprecated](https://shopify.dev/changelog/deprecating-explicit-access-grants-for-app-owned-metafields).")] public IEnumerable? grants { get; set; } /// ///The storefront access setting used for the metafields under this definition. @@ -30699,6 +30812,8 @@ public class MetafieldAccess : GraphQLObject /// ///An explicit access grant for the metafields under this definition. + /// + ///Explicit grants are [deprecated](https://shopify.dev/changelog/deprecating-explicit-access-grants-for-app-owned-metafields). /// public class MetafieldAccessGrant : GraphQLObject { @@ -30772,15 +30887,15 @@ public enum MetafieldAdminAccessInput public class MetafieldConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetafieldEdge. + ///A list of nodes that are contained in MetafieldEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -30911,15 +31026,15 @@ public class MetafieldDefinition : GraphQLObject, INode public class MetafieldDefinitionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetafieldDefinitionEdge. + ///A list of nodes that are contained in MetafieldDefinitionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -30960,15 +31075,15 @@ public class MetafieldDefinitionConstraintValue : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetafieldDefinitionConstraintValueEdge. + ///A list of nodes that are contained in MetafieldDefinitionConstraintValueEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -30979,7 +31094,7 @@ public class MetafieldDefinitionConstraintValueConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -31195,7 +31310,7 @@ public enum MetafieldDefinitionDeleteUserErrorCode public class MetafieldDefinitionEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -31574,7 +31689,7 @@ public class MetafieldDeletePayload : GraphQLObject public class MetafieldEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -31669,6 +31784,7 @@ public enum MetafieldOwnerType /// ///The Media Image metafield owner type. /// + [Obsolete("`MEDIA_IMAGE` is deprecated.")] MEDIA_IMAGE, /// ///The Product Image metafield owner type. @@ -31730,11 +31846,14 @@ public enum MetafieldOwnerType /// [JsonPolymorphic(TypeDiscriminatorPropertyName = "__typename")] [JsonDerivedType(typeof(Collection), typeDiscriminator: "Collection")] + [JsonDerivedType(typeof(Company), typeDiscriminator: "Company")] + [JsonDerivedType(typeof(Customer), typeDiscriminator: "Customer")] [JsonDerivedType(typeof(GenericFile), typeDiscriminator: "GenericFile")] [JsonDerivedType(typeof(MediaImage), typeDiscriminator: "MediaImage")] [JsonDerivedType(typeof(Metaobject), typeDiscriminator: "Metaobject")] [JsonDerivedType(typeof(Model3d), typeDiscriminator: "Model3d")] [JsonDerivedType(typeof(OnlineStorePage), typeDiscriminator: "OnlineStorePage")] + [JsonDerivedType(typeof(Order), typeDiscriminator: "Order")] [JsonDerivedType(typeof(Product), typeDiscriminator: "Product")] [JsonDerivedType(typeof(ProductVariant), typeDiscriminator: "ProductVariant")] [JsonDerivedType(typeof(TaxonomyValue), typeDiscriminator: "TaxonomyValue")] @@ -31742,11 +31861,14 @@ public enum MetafieldOwnerType public interface IMetafieldReference : IGraphQLObject { public Collection? AsCollection() => this as Collection; + public Company? AsCompany() => this as Company; + public Customer? AsCustomer() => this as Customer; public GenericFile? AsGenericFile() => this as GenericFile; public MediaImage? AsMediaImage() => this as MediaImage; public Metaobject? AsMetaobject() => this as Metaobject; public Model3d? AsModel3d() => this as Model3d; public OnlineStorePage? AsOnlineStorePage() => this as OnlineStorePage; + public Order? AsOrder() => this as Order; public Product? AsProduct() => this as Product; public ProductVariant? AsProductVariant() => this as ProductVariant; public TaxonomyValue? AsTaxonomyValue() => this as TaxonomyValue; @@ -31763,15 +31885,15 @@ public interface IMetafieldReference : IGraphQLObject public class MetafieldReferenceConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetafieldReferenceEdge. + ///A list of nodes that are contained in MetafieldReferenceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -31782,7 +31904,7 @@ public class MetafieldReferenceConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -31882,15 +32004,15 @@ public class MetafieldRelation : GraphQLObject public class MetafieldRelationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetafieldRelationEdge. + ///A list of nodes that are contained in MetafieldRelationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -31901,7 +32023,7 @@ public class MetafieldRelationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -31992,15 +32114,15 @@ public class MetafieldStorefrontVisibility : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetafieldStorefrontVisibilityEdge. + ///A list of nodes that are contained in MetafieldStorefrontVisibilityEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -32041,7 +32163,7 @@ public class MetafieldStorefrontVisibilityDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -32482,15 +32604,15 @@ public class MetaobjectCapabilityDefinitionDataRenderable : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetaobjectEdge. + ///A list of nodes that are contained in MetaobjectEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -32575,15 +32697,15 @@ public class MetaobjectDefinition : GraphQLObject, INode public class MetaobjectDefinitionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MetaobjectDefinitionEdge. + ///A list of nodes that are contained in MetaobjectDefinitionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -32624,7 +32746,7 @@ public class MetaobjectDefinitionDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -32669,7 +32791,7 @@ public class MetaobjectDeletePayload : GraphQLObject public class MetaobjectEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -33033,15 +33155,15 @@ public interface IMobilePlatformApplication : IGraphQLObject public class MobilePlatformApplicationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in MobilePlatformApplicationEdge. + ///A list of nodes that are contained in MobilePlatformApplicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -33082,7 +33204,7 @@ public class MobilePlatformApplicationDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -33340,7 +33462,7 @@ public class Mutation : GraphQLObject /// ///Creates and runs a bulk operation query. /// - ///See the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details. + ///See the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/queries) for more details. /// public BulkOperationRunQueryPayload? bulkOperationRunQuery { get; set; } /// @@ -33692,8 +33814,7 @@ public class Mutation : GraphQLObject ///Creates a delegate access token. /// ///To learn more about creating delegate access tokens, refer to - ///[Delegate OAuth access tokens to subsystems] - ///(https://shopify.dev/apps/auth/oauth/delegate-access-tokens). + ///[Delegate OAuth access tokens to subsystems](https://shopify.dev/docs/apps/build/authentication-authorization/access-tokens/use-delegate-tokens). /// public DelegateAccessTokenCreatePayload? delegateAccessTokenCreate { get; set; } /// @@ -33927,10 +34048,14 @@ public class Mutation : GraphQLObject public EventBridgeServerPixelUpdatePayload? eventBridgeServerPixelUpdate { get; set; } /// ///Creates a new Amazon EventBridge webhook subscription. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public EventBridgeWebhookSubscriptionCreatePayload? eventBridgeWebhookSubscriptionCreate { get; set; } /// ///Updates an Amazon EventBridge webhook subscription. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public EventBridgeWebhookSubscriptionUpdatePayload? eventBridgeWebhookSubscriptionUpdate { get; set; } /// @@ -33978,10 +34103,12 @@ public class Mutation : GraphQLObject ///Deletes a fulfillment constraint rule and its metafields. /// public FulfillmentConstraintRuleDeletePayload? fulfillmentConstraintRuleDelete { get; set; } + /// ///Creates a fulfillment for one or many fulfillment orders. ///The fulfillment orders are associated with the same order and are assigned to the same location. /// + [Obsolete("Use `fulfillmentCreate` instead.")] public FulfillmentCreateV2Payload? fulfillmentCreateV2 { get; set; } /// ///Creates a fulfillment event for a specified fulfillment. @@ -34092,9 +34219,11 @@ public class Mutation : GraphQLObject ///Sends a fulfillment request to the fulfillment service of a fulfillment order. /// public FulfillmentOrderSubmitFulfillmentRequestPayload? fulfillmentOrderSubmitFulfillmentRequest { get; set; } + /// ///Releases the fulfillment holds on a list of fulfillment orders. /// + [Obsolete("This mutation is deprecated and will be removed in the 2024-10 API version.\n Consider using the fulfillmentOrderReleaseHold mutation instead.")] public FulfillmentOrdersReleaseHoldsPayload? fulfillmentOrdersReleaseHolds { get; set; } /// ///Sets the latest date and time by which the fulfillment orders need to be fulfilled. @@ -34131,17 +34260,21 @@ public class Mutation : GraphQLObject ///mutation. /// public FulfillmentServiceUpdatePayload? fulfillmentServiceUpdate { get; set; } + /// ///Updates tracking information for a fulfillment. /// + [Obsolete("Use `fulfillmentTrackingInfoUpdate` instead.")] public FulfillmentTrackingInfoUpdateV2Payload? fulfillmentTrackingInfoUpdateV2 { get; set; } /// ///Create a gift card. /// public GiftCardCreatePayload? giftCardCreate { get; set; } + /// ///Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled. /// + [Obsolete("Use `giftCardDeactivate` instead.")] public GiftCardDisablePayload? giftCardDisable { get; set; } /// ///Update a gift card. @@ -34175,7 +34308,7 @@ public class Mutation : GraphQLObject /// ///Set inventory on-hand quantities using absolute values. /// - [Obsolete("Use inventorySetQuantities to set on_hand or available quantites instead.")] + [Obsolete("Use `inventorySetQuantities` to set on_hand or available quantites instead.")] public InventorySetOnHandQuantitiesPayload? inventorySetOnHandQuantities { get; set; } /// ///Set quantities of specified name using absolute values. This mutation supports compare-and-set functionality to handle @@ -34353,9 +34486,11 @@ public class Mutation : GraphQLObject ///Updates a metafield definition. /// public MetafieldDefinitionUpdatePayload? metafieldDefinitionUpdate { get; set; } + /// ///Deletes a metafield. /// + [Obsolete("This mutation will be removed in a future version. Use `metafieldsDelete` instead.")] public MetafieldDeletePayload? metafieldDelete { get; set; } /// @@ -34490,7 +34625,7 @@ public class Mutation : GraphQLObject /// ///Removes a line item discount that was applied as part of an order edit. /// - [Obsolete("Use generic OrderEditRemoveDiscount mutation instead.")] + [Obsolete("Use `orderEditRemoveDiscount` instead.")] public OrderEditRemoveLineItemDiscountPayload? orderEditRemoveLineItemDiscount { get; set; } /// ///Removes a shipping line from an existing order. For more information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). @@ -34661,44 +34796,17 @@ public class Mutation : GraphQLObject ///Updates a componentized product. /// public ProductBundleUpdatePayload? productBundleUpdate { get; set; } + /// ///Changes the status of a product. This allows you to set the availability of the product across all channels. /// + [Obsolete("Use `productUpdate` instead.")] public ProductChangeStatusPayload? productChangeStatus { get; set; } /// ///Creates a product. /// - ///For versions `2024-01` and older: - /// - ///If you need to create a product with many - ///[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) - ///that are active at several - ///[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), - ///especially with a lot of - ///[collections](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-collectionstojoin) - ///and - ///[tags](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-tags), - ///then you should first create the product with just the variants. - /// - ///After the product is created, you can activate the variants at locations - ///and add the other related objects to the product. This reduces the size of each mutation and increases the likelihood that it will - ///complete before the operation times out. - /// - ///The following example shows how you might break up product creation and object association into multiple steps: - /// - ///1. Create the product with variants. Don't specify any tags or collections on the product, and don't specify - ///[inventory quantities](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput#field-productvariantinput-inventoryquantities) - ///for each variant. - /// - ///2. After the product is created, add tags to the product using the - ///[tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsAdd) mutation, and add collections using the - ///[collectionsAddProducts](https://shopify.dev/api/admin-graphql/latest/mutations/collectionAddProducts) mutation. - /// - ///3. Use the [inventoryBulkToggleActivation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkToggleActivation) mutation - ///on each [inventory item](https://shopify.dev/api/admin-graphql/latest/objects/InventoryItem) to activate it at the appropriate locations. - /// - ///4. After activating the variants at the locations, adjust inventory quantities for the inventory items using the - ///[inventoryAdjustQuantities](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryAdjustQuantities) mutation. + ///Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) + ///and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data). /// public ProductCreatePayload? productCreate { get; set; } /// @@ -34717,9 +34825,11 @@ public class Mutation : GraphQLObject ///mutation. /// public ProductDeletePayload? productDelete { get; set; } + /// ///Deletes a product asynchronously, including all associated variants and media. /// + [Obsolete("Use `productDelete` instead.")] public ProductDeleteAsyncPayload? productDeleteAsync { get; set; } /// @@ -34734,18 +34844,26 @@ public class Mutation : GraphQLObject /// ///Duplicates a product. /// - ///As of API version `2023-01`, if you need to duplicate a large product, such as one that has many + ///If you need to duplicate a large product, such as one that has many ///[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) ///that are active at several ///[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), - ///you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous - ///[ProductDuplicateAsyncV2](https://shopify.dev/api/admin-graphql/latest/mutations/productDuplicateAsyncV2) - ///mutation. + ///you might encounter timeout errors. + /// + ///To avoid these timeout errors, you can instead duplicate the product asynchronously. + /// + ///In API version 2024-10 and higher, include `synchronous: false` argument in this mutation to perform the duplication asynchronously. + /// + ///In API version 2024-07 and lower, use the asynchronous [`ProductDuplicateAsyncV2`](https://shopify.dev/api/admin-graphql/2024-07/mutations/productDuplicateAsyncV2). /// public ProductDuplicatePayload? productDuplicate { get; set; } + /// ///Asynchronously duplicate a single product. + /// + ///For API version 2024-10 and higher, use the `productDuplicate` mutation with the `synchronous: false` argument instead. /// + [Obsolete("Use `productDuplicate` instead.")] public ProductDuplicateAsyncV2Payload? productDuplicateAsyncV2 { get; set; } /// ///Creates a product feed for a specific publication. @@ -34901,13 +35019,17 @@ public class Mutation : GraphQLObject ///Appends media from a product to variants of the product. /// public ProductVariantAppendMediaPayload? productVariantAppendMedia { get; set; } + /// ///Creates a product variant. /// + [Obsolete("Use `productVariantsBulkCreate` instead.")] public ProductVariantCreatePayload? productVariantCreate { get; set; } + /// ///Deletes a product variant. /// + [Obsolete("Use `productVariantsBulkDelete` instead.")] public ProductVariantDeletePayload? productVariantDelete { get; set; } /// ///Detaches media from product variants. @@ -34925,27 +35047,26 @@ public class Mutation : GraphQLObject ///Creates new bundles, updates existing bundles, and removes bundle components for one or multiple bundles. /// public ProductVariantRelationshipBulkUpdatePayload? productVariantRelationshipBulkUpdate { get; set; } + /// ///Updates a product variant. /// + [Obsolete("Use `productVariantsBulkUpdate` instead.")] public ProductVariantUpdatePayload? productVariantUpdate { get; set; } /// - ///Creates product variants in bulk. If you want to create a single variant, then use - ///[productVariantCreate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantcreate). + ///Creates multiple variants in a single product. This mutation can be called directly or via the bulkOperation. /// public ProductVariantsBulkCreatePayload? productVariantsBulkCreate { get; set; } /// - ///Deletes product variants in bulk. If you want to delete a single variant, then use - ///[productVariantDelete](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantdelete). + ///Deletes multiple variants in a single product. This mutation can be called directly or via the bulkOperation. /// public ProductVariantsBulkDeletePayload? productVariantsBulkDelete { get; set; } /// - ///Reorder product variants in bulk. + ///Reorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation. /// public ProductVariantsBulkReorderPayload? productVariantsBulkReorder { get; set; } /// - ///Updates product variants in bulk. If you want to update a single variant, then use - ///[productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate). + ///Updates multiple variants in a single product. This mutation can be called directly or via the bulkOperation. /// public ProductVariantsBulkUpdatePayload? productVariantsBulkUpdate { get; set; } /// @@ -34955,10 +35076,14 @@ public class Mutation : GraphQLObject public PubSubServerPixelUpdatePayload? pubSubServerPixelUpdate { get; set; } /// ///Creates a new Google Cloud Pub/Sub webhook subscription. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public PubSubWebhookSubscriptionCreatePayload? pubSubWebhookSubscriptionCreate { get; set; } /// ///Updates a Google Cloud Pub/Sub webhook subscription. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public PubSubWebhookSubscriptionUpdatePayload? pubSubWebhookSubscriptionUpdate { get; set; } /// @@ -35060,7 +35185,7 @@ public class Mutation : GraphQLObject /// ///Disposes reverse delivery line items for a reverse delivery on the same shop. /// - [Obsolete("`reverseDeliveryDispose` will be removed in API version 2025-01. Use `reverseFulfillmentOrderDispose` instead.")] + [Obsolete("`reverseDeliveryDispose` will be removed in API version 2024-10. Use `reverseFulfillmentOrderDispose` instead.")] public ReverseDeliveryDisposePayload? reverseDeliveryDispose { get; set; } /// ///Updates a reverse delivery with associated external shipping information. @@ -35140,7 +35265,7 @@ public class Mutation : GraphQLObject /// public SellingPlanGroupCreatePayload? sellingPlanGroupCreate { get; set; } /// - ///Delete a Selling Plan Group. + ///Delete a Selling Plan Group. This does not affect subscription contracts. /// public SellingPlanGroupDeletePayload? sellingPlanGroupDelete { get; set; } /// @@ -35251,7 +35376,11 @@ public class Mutation : GraphQLObject /// public StoreCreditAccountDebitPayload? storeCreditAccountDebit { get; set; } /// - ///Creates a storefront access token. An app can have a maximum of 100 active storefront access tokens for each shop. + ///Creates a storefront access token for use with the [Storefront API](https://shopify.dev/docs/api/storefront). + /// + ///An app can have a maximum of 100 active storefront access tokens for each shop. + /// + ///[Get started with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/getting-started). /// public StorefrontAccessTokenCreatePayload? storefrontAccessTokenCreate { get; set; } /// @@ -35263,13 +35392,11 @@ public class Mutation : GraphQLObject /// public SubscriptionBillingAttemptCreatePayload? subscriptionBillingAttemptCreate { get; set; } /// - ///Asynchronously queries and charges all subscription billing cycles whose `billingAttemptExpectedDate` values fall within a specified date range and meet additional filtering criteria. - ///The results of this action can be retrieved using the `SubscriptionBillingCyclesResults` query. + ///Asynchronously queries and charges all subscription billing cycles whose [billingAttemptExpectedDate](https://shopify.dev/api/admin-graphql/latest/objects/SubscriptionBillingCycle#field-billingattemptexpecteddate) values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the [subscriptionBillingCycleBulkResults](https://shopify.dev/api/admin-graphql/latest/queries/subscriptionBillingCycleBulkResults) query. /// public SubscriptionBillingCycleBulkChargePayload? subscriptionBillingCycleBulkCharge { get; set; } /// - ///Asynchronously queries all subscription billing cycles whose `billingAttemptExpectedDate` values fall within a specified date range and meet additional filtering criteria. - ///The results of this action can be retrieved using the `SubscriptionBillingCyclesResults` query. + ///Asynchronously queries all subscription billing cycles whose [billingAttemptExpectedDate](https://shopify.dev/api/admin-graphql/latest/objects/SubscriptionBillingCycle#field-billingattemptexpecteddate) values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the [subscriptionBillingCycleBulkResults](https://shopify.dev/api/admin-graphql/latest/queries/subscriptionBillingCycleBulkResults) query. /// public SubscriptionBillingCycleBulkSearchPayload? subscriptionBillingCycleBulkSearch { get; set; } /// @@ -35351,7 +35478,7 @@ public class Mutation : GraphQLObject /// public SubscriptionContractSetNextBillingDatePayload? subscriptionContractSetNextBillingDate { get; set; } /// - ///Updates a Subscription Contract. + ///The subscriptionContractUpdate mutation allows you to create a draft of an existing subscription contract. This [draft](https://shopify.dev/api/admin-graphql/latest/objects/SubscriptionDraft) can be reviewed and modified as needed. Once the draft is committed with [subscriptionDraftCommit](https://shopify.dev/api/admin-graphql/latest/mutations/subscriptionDraftCommit), the changes are applied to the original subscription contract. /// public SubscriptionContractUpdatePayload? subscriptionContractUpdate { get; set; } /// @@ -35491,14 +35618,20 @@ public class Mutation : GraphQLObject public WebPixelUpdatePayload? webPixelUpdate { get; set; } /// ///Creates a new webhook subscription. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public WebhookSubscriptionCreatePayload? webhookSubscriptionCreate { get; set; } /// ///Deletes a webhook subscription. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public WebhookSubscriptionDeletePayload? webhookSubscriptionDelete { get; set; } /// ///Updates a webhook subscription. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public WebhookSubscriptionUpdatePayload? webhookSubscriptionUpdate { get; set; } } @@ -35553,7 +35686,7 @@ public interface INavigable : IGraphQLObject public Product? AsProduct() => this as Product; public ProductVariant? AsProductVariant() => this as ProductVariant; /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; } } @@ -35713,7 +35846,6 @@ public class NavigationItem : GraphQLObject [JsonDerivedType(typeof(RefundShippingLine), typeDiscriminator: "RefundShippingLine")] [JsonDerivedType(typeof(Return), typeDiscriminator: "Return")] [JsonDerivedType(typeof(ReturnLineItem), typeDiscriminator: "ReturnLineItem")] - [JsonDerivedType(typeof(ReturnLineItem), typeDiscriminator: "ReturnLineItem")] [JsonDerivedType(typeof(ReturnableFulfillment), typeDiscriminator: "ReturnableFulfillment")] [JsonDerivedType(typeof(ReverseDelivery), typeDiscriminator: "ReverseDelivery")] [JsonDerivedType(typeof(ReverseDeliveryLineItem), typeDiscriminator: "ReverseDeliveryLineItem")] @@ -35966,7 +36098,7 @@ public class OnlineStore : GraphQLObject public class OnlineStoreArticle : GraphQLObject, IHasMetafieldDefinitions, IHasMetafields, IHasPublishedTranslations, INavigable, INode, IMetafieldReferencer { /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// @@ -35974,15 +36106,20 @@ public class OnlineStoreArticle : GraphQLObject, IHasMetafie /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -35998,7 +36135,7 @@ public class OnlineStoreArticle : GraphQLObject, IHasMetafie [Obsolete("Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).")] public PrivateMetafieldConnection? privateMetafields { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } } @@ -36014,15 +36151,20 @@ public class OnlineStoreBlog : GraphQLObject, IHasMetafieldDefi /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -36038,7 +36180,7 @@ public class OnlineStoreBlog : GraphQLObject, IHasMetafieldDefi [Obsolete("Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).")] public PrivateMetafieldConnection? privateMetafields { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } } @@ -36049,7 +36191,7 @@ public class OnlineStoreBlog : GraphQLObject, IHasMetafieldDefi public class OnlineStorePage : GraphQLObject, IHasMetafieldDefinitions, IHasMetafields, IHasPublishedTranslations, INavigable, INode, IMetafieldReference, IMetafieldReferencer { /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// @@ -36057,15 +36199,20 @@ public class OnlineStorePage : GraphQLObject, IHasMetafieldDefi /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -36081,7 +36228,7 @@ public class OnlineStorePage : GraphQLObject, IHasMetafieldDefi [Obsolete("Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).")] public PrivateMetafieldConnection? privateMetafields { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } } @@ -36106,7 +36253,7 @@ public interface IOnlineStorePreviewable : IGraphQLObject { public Product? AsProduct() => this as Product; /// - ///The online store preview URL. + ///The [preview URL](https://help.shopify.com/manual/online-store/setting-up#preview-your-store) for the online store. /// public string? onlineStorePreviewUrl { get; } } @@ -36123,7 +36270,7 @@ public interface IOnlineStorePreviewable : IGraphQLObject /// ///**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. /// - public class Order : GraphQLObject, ICommentEventSubject, IHasEvents, IHasLocalizationExtensions, IHasMetafieldDefinitions, IHasMetafields, ILegacyInteroperability, INode, ICommentEventEmbed, IMetafieldReferencer + public class Order : GraphQLObject, ICommentEventSubject, IHasEvents, IHasLocalizationExtensions, IHasMetafieldDefinitions, IHasMetafields, ILegacyInteroperability, INode, ICommentEventEmbed, IMetafieldReference, IMetafieldReferencer { /// ///A list of additional fees applied to the order. @@ -36273,7 +36420,7 @@ public class Order : GraphQLObject, ICommentEventSubject, IHasEvents, IHa /// public ulong? currentTotalWeight { get; set; } /// - ///A list of the custom attributes added to the order. + ///A list of additional merchant-facing details that have been added to the order. For example, whether an order is a customer's first. /// public IEnumerable? customAttributes { get; set; } /// @@ -36431,15 +36578,20 @@ public class Order : GraphQLObject, ICommentEventSubject, IHasEvents, IHa /// public OrderApp? merchantOfRecordApp { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -37024,15 +37176,15 @@ public class OrderClosePayload : GraphQLObject public class OrderConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in OrderEdge. + ///A list of nodes that are contained in OrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -37242,7 +37394,7 @@ public class OrderDisputeSummary : GraphQLObject, INode public class OrderEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -38183,15 +38335,15 @@ public class OrderStagedChangeAddVariant : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in OrderStagedChangeEdge. + ///A list of nodes that are contained in OrderStagedChangeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -38221,7 +38373,7 @@ public class OrderStagedChangeDecrementItem : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -38423,15 +38575,15 @@ public class OrderTransaction : GraphQLObject, INode public class OrderTransactionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in OrderTransactionEdge. + ///A list of nodes that are contained in OrderTransactionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -38442,7 +38594,7 @@ public class OrderTransactionConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -38700,15 +38852,20 @@ public class PaymentCustomization : GraphQLObject, IHasMet /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -38754,15 +38911,15 @@ public class PaymentCustomizationActivationPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PaymentCustomizationEdge. + ///A list of nodes that are contained in PaymentCustomizationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -38803,7 +38960,7 @@ public class PaymentCustomizationDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -39064,15 +39221,15 @@ public class PaymentSchedule : GraphQLObject, INode public class PaymentScheduleConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PaymentScheduleEdge. + ///A list of nodes that are contained in PaymentScheduleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -39083,7 +39240,7 @@ public class PaymentScheduleConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -39540,15 +39697,15 @@ public enum PriceListCompareAtMode public class PriceListConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PriceListEdge. + ///A list of nodes that are contained in PriceListEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -39589,7 +39746,7 @@ public class PriceListDeletePayload : GraphQLObject public class PriceListEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -39782,15 +39939,15 @@ public class PriceListPrice : GraphQLObject public class PriceListPriceConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PriceListPriceEdge. + ///A list of nodes that are contained in PriceListPriceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -39801,7 +39958,7 @@ public class PriceListPriceConnection : GraphQLObject, public class PriceListPriceEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -40262,15 +40419,15 @@ public enum PriceRuleAllocationMethod public class PriceRuleConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PriceRuleEdge. + ///A list of nodes that are contained in PriceRuleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -40394,15 +40551,15 @@ public class PriceRuleDiscountCode : GraphQLObject, INode public class PriceRuleDiscountCodeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PriceRuleDiscountCodeEdge. + ///A list of nodes that are contained in PriceRuleDiscountCodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -40438,7 +40595,7 @@ public class PriceRuleDiscountCodeCreatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -40478,7 +40635,7 @@ public class PriceRuleDiscountCodeUpdatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -41261,15 +41418,15 @@ public class PrivateMetafield : GraphQLObject, INode public class PrivateMetafieldConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PrivateMetafieldEdge. + ///A list of nodes that are contained in PrivateMetafieldEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -41295,7 +41452,7 @@ public class PrivateMetafieldDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -41339,50 +41496,72 @@ public enum 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). + ///The `Product` object lets you manage products in a merchant’s store. + /// + ///Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. + ///You can use [product variants](https://shopify.dev/docs/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/docs/api/admin-graphql/latest/interfaces/media). + ///Products can be organized by grouping them into a [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/collection). + /// + ///Learn more about working with [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components), + ///including limitations and considerations. /// public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMetafields, IHasPublishedTranslations, ILegacyInteroperability, INavigable, INode, IOnlineStorePreviewable, IPublishable, ICommentEventEmbed, IMetafieldReference, IMetafieldReferencer { /// - ///The number of publications a resource is published to without feedback errors. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// public Count? availablePublicationsCount { get; set; } /// - ///The description of the product, complete with HTML formatting. + ///The description of the product, with + ///HTML tags. For example, the description might include + ///bold `` and italic `` text. /// [Obsolete("Use `descriptionHtml` instead.")] public string? bodyHtml { get; set; } /// - ///A list of product components that are connected to this product via group relationships. + ///A list of [components](https://shopify.dev/docs/apps/build/product-merchandising/bundles/add-product-fixed-bundle) + ///that are associated with a product in a bundle. /// public ProductBundleComponentConnection? bundleComponents { get; set; } /// - ///The taxonomy category specified by the merchant. + ///The category of a product + ///from [Shopify's Standard Product Taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17). /// public TaxonomyCategory? category { get; set; } /// - ///A list of the collections that include the product. + ///A list of [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) + ///that include the product. /// public CollectionConnection? collections { get; set; } /// - ///The combined listing. + ///A special product type that combines separate products from a store into a single product listing. + ///[Combined listings](https://shopify.dev/apps/build/product-merchandising/combined-listings) are connected + ///by a shared option, such as color, model, or dimension. /// public CombinedListing? combinedListing { get; set; } /// - ///The role of the product in a combined listing. If null, the product not a part of any combined_listing. + ///The [role of the product](https://shopify.dev/docs/apps/build/product-merchandising/combined-listings/build-for-combined-listings) + ///in a combined listing. + /// + ///If `null`, then the product isn't part of any combined listing. /// public CombinedListingsRole? combinedListingRole { get; set; } /// - ///The compare-at price range of the product in the default shop currency. + ///The [compare-at price range](https://help.shopify.com/manual/products/details/product-pricing/sale-pricing) + ///of the product in the shop's default currency. /// public ProductCompareAtPriceRange? compareAtPriceRange { get; set; } /// - ///The pricing that applies for a customer in a given context. + ///The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. /// public ProductContextualPricing? contextualPricing { get; set; } /// - ///The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created. + ///The date and time when the product was created. /// public DateTime? createdAt { get; set; } @@ -41392,15 +41571,18 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet [Obsolete("Deprecated in API version 2022-10. Use `productType` instead.")] public string? customProductType { get; set; } /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// - ///A stripped description of the product, single line with HTML tags removed. + ///A single-line description of the product, + ///with [HTML tags](https://developer.mozilla.org/en-US/docs/Web/HTML) removed. /// public string? description { get; set; } /// - ///The description of the product, complete with HTML formatting. + ///The description of the product, with + ///HTML tags. For example, the description might include + ///bold `` and italic `` text. /// public string? descriptionHtml { get; set; } @@ -41410,24 +41592,33 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet /// [Obsolete("Use `description` instead.")] public string? descriptionPlainSummary { get; set; } + /// ///The featured image for the product. /// + [Obsolete("Use `featuredMedia` instead.")] public Image? featuredImage { get; set; } /// - ///The featured media for the product. + ///The featured [media](https://shopify.dev/docs/apps/build/online-store/product-media) + ///associated with the product. /// public IMedia? featuredMedia { get; set; } /// - ///Information about the product that's provided through resource feedback. + ///The information that lets merchants know what steps they need to take + ///to make sure that the app is set up correctly. + /// + ///For example, if a merchant hasn't set up a product correctly in the app, + ///then the feedback might include a message that says "You need to add a price + ///to this product". /// public ResourceFeedback? feedback { get; set; } /// - ///The theme template used when viewing the gift card in a store. + ///The [theme template](https://shopify.dev/docs/storefronts/themes/architecture/templates) that's used when customers view the gift card in a store. /// public string? giftCardTemplateSuffix { get; set; } /// - ///A unique human-friendly string of the product's title. + ///A unique, human-readable string of the product's title. A handle can contain letters, hyphens (`-`), and numbers, but no spaces. + ///The handle is used in the online store URL for the product. /// public string? handle { get; set; } /// @@ -41435,23 +41626,31 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet /// public bool? hasOnlyDefaultVariant { get; set; } /// - ///Whether the product has out of stock variants. + ///Whether the product has variants that are out of stock. /// public bool? hasOutOfStockVariants { get; set; } /// - ///Determines if at least one of the product variant requires components. The default value is `false`. + ///Whether at least one of the product variants requires + ///[bundle components](https://shopify.dev/docs/apps/build/product-merchandising/bundles/add-product-fixed-bundle). + /// + ///Learn more about + ///[store eligibility for bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles#store-eligibility). /// public bool? hasVariantsThatRequiresComponents { get; set; } /// ///A globally-unique ID. /// public string? id { get; set; } + /// ///The images associated with the product. /// + [Obsolete("Use `media` instead.")] public ImageConnection? images { get; set; } /// - ///Whether the product is in a given collection. + ///Whether the product + ///is in a specified + ///[collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/collection). /// public bool? inCollection { get; set; } /// @@ -41463,36 +41662,43 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet /// public ulong? legacyResourceId { get; set; } /// - ///The media associated with the product. This can include images, 3D models, or videos. + ///The [media](https://shopify.dev/docs/apps/build/online-store/product-media) associated with the product. Valid media are images, 3D models, videos. /// public MediaConnection? media { get; set; } /// - ///Total count of media belonging to a product. + ///The total count of [media](https://shopify.dev/docs/apps/build/online-store/product-media) + ///that's associated with a product. /// public Count? mediaCount { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// - ///The online store preview URL. + ///The [preview URL](https://help.shopify.com/manual/online-store/setting-up#preview-your-store) for the online store. /// public string? onlineStorePreviewUrl { get; set; } /// - ///The online store URL for the product. - ///A value of `null` indicates that the product isn't published to the Online Store sales channel. + ///The product's URL on the online store. + ///If `null`, then the product isn't published to the online store sales channel. /// public string? onlineStoreUrl { get; set; } /// - ///A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions. + ///A list of product options. The limit is defined by the + ///[shop's resource limits for product options](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-resourcelimits) (`Shop.resourceLimits.maxProductOptions`). /// public IEnumerable? options { get; set; } @@ -41502,7 +41708,9 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet [Obsolete("Deprecated in API version 2020-10. Use `priceRangeV2` instead.")] public ProductPriceRange? priceRange { get; set; } /// - ///The price range of the product with prices formatted as decimals. + ///The minimum and maximum prices of a product, expressed in decimal numbers. + ///For example, if the product is priced between $10.00 and $50.00, + ///then the price range is $10.00 - $50.00. /// public ProductPriceRangeV2? priceRangeV2 { get; set; } @@ -41530,12 +41738,16 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet [Obsolete("Use `resourcePublications` instead.")] public ProductPublicationConnection? productPublications { get; set; } /// - ///The product type specified by the merchant. + ///The [product type](https://help.shopify.com/manual/products/details/product-type) + ///that merchants define. /// public string? productType { get; set; } /// - ///The number of publications a resource is published on. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// [Obsolete("Use `resourcePublicationsCount` instead.")] public int? publicationCount { get; set; } @@ -41546,69 +41758,87 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet [Obsolete("Use `resourcePublications` instead.")] public ProductPublicationConnection? publications { get; set; } /// - ///The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was published to the Online Store. + ///The date and time when the product was published to the online store. /// public DateTime? publishedAt { get; set; } /// - ///Whether or not the product is published for a customer in the given context. + ///Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location. /// public bool? publishedInContext { get; set; } /// - ///Check to see whether the resource is published to a given channel. + ///Whether the resource is published to a specific channel. /// [Obsolete("Use `publishedOnPublication` instead.")] public bool? publishedOnChannel { get; set; } /// - ///Check to see whether the resource is published to the calling app's channel. + ///Whether the resource is published to a + ///[channel](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel). + ///For example, the resource might be published to the online store channel. /// [Obsolete("Use `publishedOnCurrentPublication` instead.")] public bool? publishedOnCurrentChannel { get; set; } /// - ///Check to see whether the resource is published to the calling app's publication. + ///Whether the resource is published to the app's + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). + ///For example, the resource might be published to the app's online store channel. /// public bool? publishedOnCurrentPublication { get; set; } /// - ///Check to see whether the resource is published to a given publication. + ///Whether the resource is published to a specified + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public bool? publishedOnPublication { get; set; } /// - ///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. + ///Whether the product can only be purchased with + ///a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans). + ///Products that are sold on subscription (`requiresSellingPlan: true`) can be updated only for online stores. + ///If you update a product to be subscription-only (`requiresSellingPlan:false`), then the product is unpublished from all channels, except the online store. /// public bool? requiresSellingPlan { get; set; } /// - ///The resource that's either published or staged to be published to the calling app's publication. Requires the `read_product_listings` scope. + ///The resource that's either published or staged to be published to + ///the [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public ResourcePublicationV2? resourcePublicationOnCurrentPublication { get; set; } /// - ///The list of resources that are published to a publication. + ///The list of resources that are published to a + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public ResourcePublicationConnection? resourcePublications { get; set; } /// - ///The number of publications a resource is published on. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// public Count? resourcePublicationsCount { get; set; } /// - ///The list of resources that are either published or staged to be published to a publication. + ///The list of resources that are either published or staged to be published to a + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public ResourcePublicationV2Connection? resourcePublicationsV2 { get; set; } /// - ///Count of selling plan groups associated with the product. + ///A count of [selling plan groups](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan) + ///that are associated with the product. /// [Obsolete("Use `sellingPlanGroupsCount` instead.")] public int? sellingPlanGroupCount { get; set; } /// - ///A list of all selling plan groups defined in the current shop associated with the product either directly or through any of its variants. + ///A list of all [selling plan groups](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan) + ///that are associated with the product either directly, or through the product's variants. /// public SellingPlanGroupConnection? sellingPlanGroups { get; set; } /// - ///Count of selling plan groups associated with the product. + ///A count of [selling plan groups](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan) + ///that are associated with the product. /// public Count? sellingPlanGroupsCount { get; set; } /// - ///SEO information of the product. + ///The [SEO title and description](https://help.shopify.com/manual/promoting-marketing/seo/adding-keywords) + ///that are associated with a product. /// public SEO? seo { get; set; } @@ -41618,7 +41848,8 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet [Obsolete("Deprecated in API version 2022-10. Use `productCategory` instead.")] public StandardizedProductType? standardizedProductType { get; set; } /// - ///The product status. This controls visibility across all channels. + ///The [product status](https://help.shopify.com/manual/products/details/product-details-page#product-status), + ///which controls visibility across all sales channels. /// public ProductStatus? status { get; set; } @@ -41630,36 +41861,43 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet [Obsolete("Use `id` instead.")] public string? storefrontId { get; set; } /// - ///A comma separated list of tags associated with the product. Updating `tags` overwrites + ///A comma-separated list of searchable keywords that are + ///associated with the product. For example, a merchant might apply the `sports` + ///and `summer` tags to products that are associated with sportwear for summer. + /// + ///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) + ///existing tags, use the [`tagsAdd`](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) ///mutation. /// public IEnumerable? tags { get; set; } /// - ///The theme template used when viewing the product in a store. + ///The [theme template](https://shopify.dev/docs/storefronts/themes/architecture/templates) that's used when customers view the product in a store. /// public string? templateSuffix { get; set; } /// - ///The title of the product. + ///The name for the product that displays to customers. The title is used to construct the product's handle. + ///For example, if a product is titled "Black Sunglasses", then the handle is `black-sunglasses`. /// public string? title { get; set; } /// - ///The quantity of inventory in stock. + ///The quantity of inventory that's in stock. /// public int? totalInventory { get; set; } /// - ///The number of variants that are associated with the product. + ///The number of [variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) + ///that are associated with the product. /// [Obsolete("Use `variantsCount` instead.")] public int? totalVariants { get; set; } /// - ///Whether inventory tracking has been enabled for the product. + ///Whether [inventory tracking](https://help.shopify.com/manual/products/inventory/getting-started-with-inventory/set-up-inventory-tracking) + ///has been enabled for the product. /// public bool? tracksInventory { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } @@ -41669,7 +41907,8 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet [Obsolete("Use `unpublishedPublications` instead.")] public ChannelConnection? unpublishedChannels { get; set; } /// - ///The list of publications that the resource is not published to. + ///The list of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that the resource isn't published to. /// public PublicationConnection? unpublishedPublications { get; set; } /// @@ -41680,11 +41919,12 @@ public class Product : GraphQLObject, IHasMetafieldDefinitions, IHasMet /// public DateTime? updatedAt { get; set; } /// - ///A list of variants associated with the product. + ///A list of [variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) associated with the product. /// public ProductVariantConnection? variants { get; set; } /// - ///The number of variants that are associated with the product. + ///The number of [variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) + ///that are associated with the product. /// public Count? variantsCount { get; set; } /// @@ -41751,15 +41991,15 @@ public class ProductBundleComponent : GraphQLObject public class ProductBundleComponentConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ProductBundleComponentEdge. + ///A list of nodes that are contained in ProductBundleComponentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -41770,7 +42010,7 @@ public class ProductBundleComponentConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -41949,7 +42189,7 @@ public class ProductBundleOperation : GraphQLObject, INo /// public string? id { get; set; } /// - ///The product that's created or updated during this operation. + ///The product on which the operation is being performed. /// public Product? product { get; set; } /// @@ -42098,15 +42338,15 @@ public class ProductCompareAtPriceRange : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ProductEdge. + ///A list of nodes that are contained in ProductEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -42132,7 +42372,9 @@ public class ProductContextualPricing : GraphQLObject /// public ProductVariantContextualPricing? minVariantPricing { get; set; } /// - ///The price range of the product with prices formatted as decimals. + ///The minimum and maximum prices of a product, expressed in decimal numbers. + ///For example, if the product is priced between $10.00 and $50.00, + ///then the price range is $10.00 - $50.00. /// public ProductPriceRangeV2? priceRange { get; set; } } @@ -42414,7 +42656,7 @@ public enum ProductDuplicateUserErrorCode public class ProductEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -42452,15 +42694,15 @@ public class ProductFeed : GraphQLObject, INode public class ProductFeedConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ProductFeedEdge. + ///A list of nodes that are contained in ProductFeedEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -42565,7 +42807,7 @@ public enum ProductFeedDeleteUserErrorCode public class ProductFeedEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -42730,7 +42972,7 @@ public interface IProductOperation : IGraphQLObject public ProductBundleOperation? AsProductBundleOperation() => this as ProductBundleOperation; public ProductSetOperation? AsProductSetOperation() => this as ProductSetOperation; /// - ///The product that's created or updated during this operation. + ///The product on which the operation is being performed. /// public Product? product { get; } /// @@ -42786,7 +43028,7 @@ public class ProductOption : GraphQLObject, IHasPublishedTranslat /// public int? position { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } /// @@ -42965,6 +43207,10 @@ public enum ProductOptionUpdateUserErrorCode ///Operation is not supported for a combined listing parent product. /// UNSUPPORTED_COMBINED_LISTING_PARENT_OPERATION, + /// + ///Cannot update the option because it would result in deleting variants, and you don't have the required permissions. + /// + CANNOT_DELETE_VARIANT_WITHOUT_PERMISSION, } /// @@ -43016,7 +43262,7 @@ public class ProductOptionValue : GraphQLObject, IHasPublish /// public ProductOptionValueSwatch? swatch { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } } @@ -43390,15 +43636,15 @@ public class ProductPublication : GraphQLObject public class ProductPublicationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ProductPublicationEdge. + ///A list of nodes that are contained in ProductPublicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -43409,7 +43655,7 @@ public class ProductPublicationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -43579,7 +43825,7 @@ public class ProductSetOperation : GraphQLObject, INode, IP /// public string? id { get; set; } /// - ///The product that's created or updated during this operation. + ///The product on which the operation is being performed. /// public Product? product { get; set; } /// @@ -43765,7 +44011,7 @@ public enum ProductSortKeys /// ///Sort by relevance to the search terms when the `query` parameter is specified on the connection. ///Don't use this sort key when no search query is specified. - ///Pagination isn't supported when using this sort key. + ///[Pagination](https://shopify.dev/api/usage/pagination-graphql) isn't supported when using this sort key. /// RELEVANCE, } @@ -43901,11 +44147,11 @@ public class ProductVariant : GraphQLObject, IHasMetafieldDefini /// public DateTime? createdAt { get; set; } /// - ///A default cursor that returns the single next record, sorted ascending by ID. + ///A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. /// public string? defaultCursor { get; set; } /// - ///The delivery profile for the variant. + ///The [delivery profile](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryProfile) for the variant. /// public DeliveryProfile? deliveryProfile { get; set; } /// @@ -43941,15 +44187,20 @@ public class ProductVariant : GraphQLObject, IHasMetafieldDefini /// public MediaConnection? media { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -44042,7 +44293,7 @@ public class ProductVariant : GraphQLObject, IHasMetafieldDefini /// public string? title { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } /// @@ -44095,15 +44346,15 @@ public class ProductVariantComponent : GraphQLObject, I public class ProductVariantComponentConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ProductVariantComponentEdge. + ///A list of nodes that are contained in ProductVariantComponentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -44114,7 +44365,7 @@ public class ProductVariantComponentConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -44129,15 +44380,15 @@ public class ProductVariantComponentEdge : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ProductVariantEdge. + ///A list of nodes that are contained in ProductVariantEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -44229,7 +44480,7 @@ public class ProductVariantDetachMediaPayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -44304,15 +44555,15 @@ public class ProductVariantPricePair : GraphQLObject public class ProductVariantPricePairConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ProductVariantPricePairEdge. + ///A list of nodes that are contained in ProductVariantPricePairEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -44323,7 +44574,7 @@ public class ProductVariantPricePairConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -44595,6 +44846,10 @@ public class ProductVariantsBulkCreateUserError : GraphQLObject public enum ProductVariantsBulkCreateUserErrorCode { + /// + ///Input is invalid. + /// + INVALID_INPUT, /// ///Product does not exist. /// @@ -44655,6 +44910,10 @@ public enum ProductVariantsBulkCreateUserErrorCode ///Operation is not supported for a combined listing parent product. /// UNSUPPORTED_COMBINED_LISTING_PARENT_OPERATION, + /// + ///Cannot set name for an option value linked to a metafield. + /// + CANNOT_SET_NAME_FOR_LINKED_OPTION_VALUE, } /// @@ -44814,6 +45073,18 @@ public class ProductVariantsBulkUpdateUserError : GraphQLObject public enum ProductVariantsBulkUpdateUserErrorCode { + /// + ///Input is invalid. + /// + INVALID_INPUT, + /// + ///Mutually exclusive input fields provided. + /// + CANNOT_SPECIFY_BOTH, + /// + ///Mandatory field input field missing. + /// + MUST_SPECIFY_ONE_OF_PAIR, /// ///Product does not exist. /// @@ -44827,6 +45098,18 @@ public enum ProductVariantsBulkUpdateUserErrorCode /// PRODUCT_VARIANT_DOES_NOT_EXIST, /// + ///Option does not exist. + /// + OPTION_DOES_NOT_EXIST, + /// + ///Option value does not exist. + /// + OPTION_VALUE_DOES_NOT_EXIST, + /// + ///Input must be for this product. + /// + MUST_BE_FOR_THIS_PRODUCT, + /// ///Inventory quantities can only be provided during create. To update inventory for existing variants, use inventoryAdjustQuantities. /// NO_INVENTORY_QUANTITIES_ON_VARIANTS_UPDATE, @@ -45085,15 +45368,15 @@ public class Publication : GraphQLObject, INode public class PublicationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in PublicationEdge. + ///A list of nodes that are contained in PublicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -45149,7 +45432,7 @@ public class PublicationDeletePayload : GraphQLObject public class PublicationEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -45336,45 +45619,61 @@ public interface IPublishable : IGraphQLObject public Collection? AsCollection() => this as Collection; public Product? AsProduct() => this as Product; /// - ///The number of publications a resource is published to without feedback errors. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// public Count? availablePublicationsCount { get; } /// - ///The number of publications a resource is published on. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// [Obsolete("Use `resourcePublicationsCount` instead.")] public int? publicationCount { get; } /// - ///Check to see whether the resource is published to a given channel. + ///Whether the resource is published to a specific channel. /// [Obsolete("Use `publishedOnPublication` instead.")] public bool? publishedOnChannel { get; } /// - ///Check to see whether the resource is published to the calling app's channel. + ///Whether the resource is published to a + ///[channel](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel). + ///For example, the resource might be published to the online store channel. /// [Obsolete("Use `publishedOnCurrentPublication` instead.")] public bool? publishedOnCurrentChannel { get; } /// - ///Check to see whether the resource is published to the calling app's publication. + ///Whether the resource is published to the app's + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). + ///For example, the resource might be published to the app's online store channel. /// public bool? publishedOnCurrentPublication { get; } /// - ///Check to see whether the resource is published to a given publication. + ///Whether the resource is published to a specified + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public bool? publishedOnPublication { get; } /// - ///The list of resources that are published to a publication. + ///The list of resources that are published to a + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public ResourcePublicationConnection? resourcePublications { get; } /// - ///The number of publications a resource is published on. + ///The number of + ///[publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that a resource is published to, without + ///[feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). /// public Count? resourcePublicationsCount { get; } /// - ///The list of resources that are either published or staged to be published to a publication. + ///The list of resources that are either published or staged to be published to a + ///[publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). /// public ResourcePublicationV2Connection? resourcePublicationsV2 { get; } @@ -45384,7 +45683,8 @@ public interface IPublishable : IGraphQLObject [Obsolete("Use `unpublishedPublications` instead.")] public ChannelConnection? unpublishedChannels { get; } /// - ///The list of publications that the resource is not published to. + ///The list of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) + ///that the resource isn't published to. /// public PublicationConnection? unpublishedPublications { get; } } @@ -45530,15 +45830,15 @@ public class QuantityPriceBreak : GraphQLObject, INode public class QuantityPriceBreakConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in QuantityPriceBreakEdge. + ///A list of nodes that are contained in QuantityPriceBreakEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -45549,7 +45849,7 @@ public class QuantityPriceBreakConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -45802,15 +46102,15 @@ public class QuantityRule : GraphQLObject public class QuantityRuleConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in QuantityRuleEdge. + ///A list of nodes that are contained in QuantityRuleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -45821,7 +46121,7 @@ public class QuantityRuleConnection : GraphQLObject, ICo public class QuantityRuleEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -46217,6 +46517,7 @@ public class QueryRoot : GraphQLObject public CustomerPaymentMethod? customerPaymentMethod { get; set; } /// ///The list of members, such as customers, that's associated with an individual segment. + ///The maximum page size is 1000. /// public CustomerSegmentMemberConnection? customerSegmentMembers { get; set; } /// @@ -46228,16 +46529,18 @@ public class QueryRoot : GraphQLObject /// public SegmentMembershipResponse? customerSegmentMembership { get; set; } /// - ///List of customers. + ///Returns a list of customers. /// public CustomerConnection? customers { get; set; } /// ///The number of customers. /// public Count? customersCount { get; set; } + /// ///The paginated list of deletion events. /// + [Obsolete("Use `events` instead.")] public DeletionEventConnection? deletionEvents { get; set; } /// ///The delivery customization. @@ -46460,7 +46763,7 @@ public class QueryRoot : GraphQLObject /// public MenuConnection? menus { get; set; } /// - ///Returns a metafield definition by ID. + ///Returns a metafield definition by identifier. /// public MetafieldDefinition? metafieldDefinition { get; set; } /// @@ -46471,7 +46774,7 @@ public class QueryRoot : GraphQLObject /// public IEnumerable? metafieldDefinitionTypes { get; set; } /// - ///List of metafield definitions. + ///Returns a list of metafield definitions. /// public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } @@ -46551,7 +46854,7 @@ public class QueryRoot : GraphQLObject /// public SavedSearchConnection? orderSavedSearches { get; set; } /// - ///Returns a list of orders placed. + ///Returns a list of orders placed in the store. /// public OrderConnection? orders { get; set; } /// @@ -46667,11 +46970,11 @@ public class QueryRoot : GraphQLObject /// public ProductVariant? productVariant { get; set; } /// - ///List of the product variants. + ///Returns a list of product variants. /// public ProductVariantConnection? productVariants { get; set; } /// - ///List of products. + ///Returns a list of products. /// public ProductConnection? products { get; set; } /// @@ -46910,14 +47213,20 @@ public class QueryRoot : GraphQLObject public WebPixel? webPixel { get; set; } /// ///Returns a webhook subscription by ID. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public WebhookSubscription? webhookSubscription { get; set; } /// ///Returns a list of webhook subscriptions. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). /// public WebhookSubscriptionConnection? webhookSubscriptions { get; set; } /// - ///The count of webhook subscriptions. Limited to a maximum of 10000. + ///The count of webhook subscriptions. + /// + ///Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). Limited to a maximum of 10000. /// public Count? webhookSubscriptionsCount { get; set; } } @@ -47028,15 +47337,15 @@ public class RefundAgreement : GraphQLObject, ISalesAgreement public class RefundConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in RefundEdge. + ///A list of nodes that are contained in RefundEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -47096,7 +47405,7 @@ public enum RefundDutyRefundType public class RefundEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -47172,15 +47481,15 @@ public class RefundLineItem : GraphQLObject public class RefundLineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in RefundLineItemEdge. + ///A list of nodes that are contained in RefundLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -47191,7 +47500,7 @@ public class RefundLineItemConnection : GraphQLObject, public class RefundLineItemEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -47244,15 +47553,15 @@ public class RefundShippingLine : GraphQLObject, INode public class RefundShippingLineConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in RefundShippingLineEdge. + ///A list of nodes that are contained in RefundShippingLineEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -47263,7 +47572,7 @@ public class RefundShippingLineConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -47496,15 +47805,15 @@ public class ResourcePublication : GraphQLObject public class ResourcePublicationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ResourcePublicationEdge. + ///A list of nodes that are contained in ResourcePublicationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -47515,7 +47824,7 @@ public class ResourcePublicationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -47557,15 +47866,15 @@ public class ResourcePublicationV2 : GraphQLObject public class ResourcePublicationV2Connection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ResourcePublicationV2Edge. + ///A list of nodes that are contained in ResourcePublicationV2Edge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -47576,7 +47885,7 @@ public class ResourcePublicationV2Connection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -47746,15 +48055,15 @@ public class ReturnClosePayload : GraphQLObject public class ReturnConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReturnEdge. + ///A list of nodes that are contained in ReturnEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -47830,7 +48139,7 @@ public class ReturnDeclineRequestPayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -48048,15 +48357,15 @@ public interface IReturnLineItemType : IGraphQLObject, INode public class ReturnLineItemTypeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReturnLineItemTypeEdge. + ///A list of nodes that are contained in ReturnLineItemTypeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -48067,7 +48376,7 @@ public class ReturnLineItemTypeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -48255,15 +48564,15 @@ public class ReturnableFulfillment : GraphQLObject, INode public class ReturnableFulfillmentConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReturnableFulfillmentEdge. + ///A list of nodes that are contained in ReturnableFulfillmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -48274,7 +48583,7 @@ public class ReturnableFulfillmentConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -48304,15 +48613,15 @@ public class ReturnableFulfillmentLineItem : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReturnableFulfillmentLineItemEdge. + ///A list of nodes that are contained in ReturnableFulfillmentLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -48323,7 +48632,7 @@ public class ReturnableFulfillmentLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -48364,15 +48673,15 @@ public class ReverseDelivery : GraphQLObject, INode public class ReverseDeliveryConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReverseDeliveryEdge. + ///A list of nodes that are contained in ReverseDeliveryEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -48431,7 +48740,7 @@ public class ReverseDeliveryDisposePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -48488,15 +48797,15 @@ public class ReverseDeliveryLineItem : GraphQLObject, I public class ReverseDeliveryLineItemConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReverseDeliveryLineItemEdge. + ///A list of nodes that are contained in ReverseDeliveryLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -48507,7 +48816,7 @@ public class ReverseDeliveryLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -48604,15 +48913,15 @@ public class ReverseFulfillmentOrder : GraphQLObject, I public class ReverseFulfillmentOrderConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReverseFulfillmentOrderEdge. + ///A list of nodes that are contained in ReverseFulfillmentOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -48684,7 +48993,7 @@ public enum ReverseFulfillmentOrderDispositionType public class ReverseFulfillmentOrderEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -48702,9 +49011,11 @@ public class ReverseFulfillmentOrderLineItem : GraphQLObject public IEnumerable? dispositions { get; set; } + /// ///The corresponding fulfillment line item for a reverse fulfillment order line item. /// + [Obsolete("FulfillmentLineItem will be nullable as of API version 2024-10. Older version will return error when FulfillmentLineItem is null.")] public FulfillmentLineItem? fulfillmentLineItem { get; set; } /// ///A globally-unique ID. @@ -48722,15 +49033,15 @@ public class ReverseFulfillmentOrderLineItem : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ReverseFulfillmentOrderLineItemEdge. + ///A list of nodes that are contained in ReverseFulfillmentOrderLineItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -48741,7 +49052,7 @@ public class ReverseFulfillmentOrderLineItemConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -49016,15 +49327,15 @@ public class SaleAdditionalFee : GraphQLObject, INode public class SaleConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SaleEdge. + ///A list of nodes that are contained in SaleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -49035,7 +49346,7 @@ public class SaleConnection : GraphQLObject, IConnectionWithNode public class SaleEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -49152,15 +49463,15 @@ public interface ISalesAgreement : IGraphQLObject public class SalesAgreementConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SalesAgreementEdge. + ///A list of nodes that are contained in SalesAgreementEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -49171,7 +49482,7 @@ public class SalesAgreementConnection : GraphQLObject, public class SalesAgreementEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -49221,15 +49532,15 @@ public class SavedSearch : GraphQLObject, ILegacyInteroperability, public class SavedSearchConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SavedSearchEdge. + ///A list of nodes that are contained in SavedSearchEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -49274,7 +49585,7 @@ public class SavedSearchDeletePayload : GraphQLObject public class SavedSearchEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -49410,15 +49721,15 @@ public class ScriptTag : GraphQLObject, ILegacyInteroperability, INod public class ScriptTagConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ScriptTagEdge. + ///A list of nodes that are contained in ScriptTagEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -49478,7 +49789,7 @@ public enum ScriptTagDisplayScope public class ScriptTagEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -49561,16 +49872,16 @@ public class SearchResult : GraphQLObject public class SearchResultConnection : GraphQLObject, IConnectionWithEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// [Obsolete("The provided information is not accurate.")] public int? resultsAfterCount { get; set; } @@ -49582,7 +49893,7 @@ public class SearchResultConnection : GraphQLObject, ICo public class SearchResultEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -49604,8 +49915,17 @@ public enum SearchResultType ///A file. /// FILE, + /// + ///A page. + /// ONLINE_STORE_PAGE, + /// + ///A blog. + /// ONLINE_STORE_BLOG, + /// + ///An article. + /// ONLINE_STORE_ARTICLE, /// ///A URL redirect. @@ -49709,15 +50029,15 @@ public class SegmentBooleanFilter : GraphQLObject, ISegmen public class SegmentConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SegmentEdge. + ///A list of nodes that are contained in SegmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -49777,7 +50097,7 @@ public class SegmentDeletePayload : GraphQLObject public class SegmentEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -49905,15 +50225,15 @@ public interface ISegmentFilter : IGraphQLObject public class SegmentFilterConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SegmentFilterEdge. + ///A list of nodes that are contained in SegmentFilterEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -49924,7 +50244,7 @@ public class SegmentFilterConnection : GraphQLObject, I public class SegmentFilterEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -50023,15 +50343,15 @@ public class SegmentMigration : GraphQLObject public class SegmentMigrationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SegmentMigrationEdge. + ///A list of nodes that are contained in SegmentMigrationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -50042,7 +50362,7 @@ public class SegmentMigrationConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -50143,15 +50463,15 @@ public class SegmentValue : GraphQLObject public class SegmentValueConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SegmentValueEdge. + ///A list of nodes that are contained in SegmentValueEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -50162,7 +50482,7 @@ public class SegmentValueConnection : GraphQLObject, ICo public class SegmentValueEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -50230,15 +50550,20 @@ public class SellingPlan : GraphQLObject, IHasMetafieldDefinitions, /// public SellingPlanInventoryPolicy? inventoryPolicy { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -50272,18 +50597,28 @@ public class SellingPlan : GraphQLObject, IHasMetafieldDefinitions, [Obsolete("Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).")] public PrivateMetafieldConnection? privateMetafields { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } } /// - ///Represents a selling plan policy anchor. + ///Specifies the date when delivery or fulfillment is completed by a merchant for a given time cycle. You can also + ///define a cutoff for which customers are eligible to enter this cycle and the desired behavior for customers who + ///start their subscription inside the cutoff period. + /// + ///Some example scenarios where anchors can be useful to implement advanced delivery behavior: + ///- A merchant starts fulfillment on a specific date every month. + ///- A merchant wants to bill the 1st of every quarter. + ///- A customer expects their delivery every Tuesday. + /// + ///For more details, see [About Selling Plans](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans#anchors). /// public class SellingPlanAnchor : GraphQLObject { /// - ///The cutoff day for the anchor. + ///The cutoff day for the anchor. Specifies a buffer period before the anchor date for orders to be included in a + ///delivery or fulfillment cycle. /// ///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. @@ -50431,15 +50766,15 @@ public interface ISellingPlanCheckoutChargeValue : IGraphQLObject public class SellingPlanConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SellingPlanEdge. + ///A list of nodes that are contained in SellingPlanEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -50473,7 +50808,7 @@ public interface ISellingPlanDeliveryPolicy : IGraphQLObject public class SellingPlanEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -50690,7 +51025,7 @@ public class SellingPlanGroup : GraphQLObject, IHasPublishedTr /// public string? summary { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } } @@ -50731,15 +51066,15 @@ public class SellingPlanGroupAddProductsPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SellingPlanGroupEdge. + ///A list of nodes that are contained in SellingPlanGroupEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -50780,7 +51115,7 @@ public class SellingPlanGroupDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -51596,15 +51931,15 @@ public class ShippingLine : GraphQLObject, IDraftOrderPlatformDisc public class ShippingLineConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ShippingLineEdge. + ///A list of nodes that are contained in ShippingLineEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -51615,7 +51950,7 @@ public class ShippingLineConnection : GraphQLObject, ICo public class ShippingLineEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -51815,7 +52150,7 @@ public class Shop : GraphQLObject, IHasMetafields, IHasPublishedTranslatio /// ///A list of the shop's product categories. Limit: 1000 product categories. /// - [Obsolete("Deprecated in API version 2024-07. Use `all_product_categories_list` instead.")] + [Obsolete("Deprecated in API version 2024-07. Use `allProductCategoriesList` instead.")] public IEnumerable? allProductCategories { get; set; } /// ///A list of the shop's product categories. Limit: 1000 product categories. @@ -52031,11 +52366,14 @@ public class Shop : GraphQLObject, IHasMetafields, IHasPublishedTranslatio /// public MerchantApprovalSignals? merchantApprovalSignals { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } /// @@ -52186,9 +52524,11 @@ public class Shop : GraphQLObject, IHasMetafields, IHasPublishedTranslatio ///The list of all legal policies associated with a shop. /// public IEnumerable? shopPolicies { get; set; } + /// ///The paginated list of the shop's staff members. /// + [Obsolete("Use `QueryRoot.staffMembers` instead.")] public StaffMemberConnection? staffMembers { get; set; } /// ///The storefront access token of a private application. These are scoped per-application. @@ -52225,7 +52565,7 @@ public class Shop : GraphQLObject, IHasMetafields, IHasPublishedTranslatio /// public bool? transactionalSmsDisabled { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } /// @@ -52236,9 +52576,11 @@ public class Shop : GraphQLObject, IHasMetafields, IHasPublishedTranslatio ///The date and time when the shop was last updated. /// public DateTime? updatedAt { get; set; } + /// ///Fetches a list of images uploaded to the shop by their IDs. /// + [Obsolete("Use `files` instead. See [filesQuery](https://shopify.dev/docs/api/admin-graphql/latest/queries/files) and its [query](https://shopify.dev/docs/api/admin-graphql/2024-01/queries/files#argument-query) argument for more information.")] public IEnumerable? uploadedImagesByIds { get; set; } /// ///The URL of the shop's online store. @@ -52677,7 +53019,7 @@ public class ShopPolicy : GraphQLObject, IHasPublishedTranslations, /// public string? title { get; set; } /// - ///The translations associated with the resource. + ///The published translations associated with the resource. /// public IEnumerable? translations { get; set; } /// @@ -52926,15 +53268,15 @@ public class ShopifyFunction : GraphQLObject public class ShopifyFunctionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ShopifyFunctionEdge. + ///A list of nodes that are contained in ShopifyFunctionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -52945,7 +53287,7 @@ public class ShopifyFunctionConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -53001,7 +53343,7 @@ public class ShopifyPaymentsAccount : GraphQLObject, INo /// public CurrencyCode? defaultCurrency { get; set; } /// - ///All disputes related to the Shopify Payments account. + ///All disputes that originated from a transaction made with the Shopify Payments account. /// public ShopifyPaymentsDisputeConnection? disputes { get; set; } /// @@ -53170,15 +53512,15 @@ public class ShopifyPaymentsBalanceTransactionAssociatedPayout : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ShopifyPaymentsBalanceTransactionEdge. + ///A list of nodes that are contained in ShopifyPaymentsBalanceTransactionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -53189,7 +53531,7 @@ public class ShopifyPaymentsBalanceTransactionConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -53287,15 +53629,15 @@ public class ShopifyPaymentsBankAccount : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ShopifyPaymentsBankAccountEdge. + ///A list of nodes that are contained in ShopifyPaymentsBankAccountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -53306,7 +53648,7 @@ public class ShopifyPaymentsBankAccountConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -53430,15 +53772,15 @@ public class ShopifyPaymentsDispute : GraphQLObject, ILe public class ShopifyPaymentsDisputeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ShopifyPaymentsDisputeEdge. + ///A list of nodes that are contained in ShopifyPaymentsDisputeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -53449,7 +53791,7 @@ public class ShopifyPaymentsDisputeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -53837,15 +54179,15 @@ public class ShopifyPaymentsPayout : GraphQLObject, ILega public class ShopifyPaymentsPayoutConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ShopifyPaymentsPayoutEdge. + ///A list of nodes that are contained in ShopifyPaymentsPayoutEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -53856,7 +54198,7 @@ public class ShopifyPaymentsPayoutConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -54668,15 +55010,15 @@ public class StaffMember : GraphQLObject, INode public class StaffMemberConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in StaffMemberEdge. + ///A list of nodes that are contained in StaffMemberEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -54706,7 +55048,7 @@ public enum StaffMemberDefaultImage public class StaffMemberEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -54729,7 +55071,11 @@ public enum StaffMemberPermission /// CHANNELS, /// - ///The staff member can view, create, update, and delete customers, and respond to customer messages in the Shopify Messaging API. + ///The staff member can create and edit customers. + /// + CREATE_AND_EDIT_CUSTOMERS, + /// + ///The staff member can view customers. /// CUSTOMERS, /// @@ -54737,6 +55083,10 @@ public enum StaffMemberPermission /// DASHBOARD, /// + ///The staff member can delete customers. + /// + DELETE_CUSTOMERS, + /// ///The staff member can view, buy, and manage domains. /// DOMAINS, @@ -54749,6 +55099,14 @@ public enum StaffMemberPermission /// EDIT_ORDERS, /// + ///The staff member can erase customer private data. + /// + ERASE_CUSTOMER_DATA, + /// + ///The staff member can export customers. + /// + EXPORT_CUSTOMERS, + /// ///The staff has the same permissions as the [store owner](https://shopify.dev/en/manual/your-account/staff-accounts/staff-permissions#store-owner-permissions) with some exceptions, such as modifying the account billing or deleting staff accounts. /// [Obsolete("Use the list of the staff member's explicit permissions returned in the `StaffMember.permissions.userPermissions` field instead of `full` permission.")] @@ -54774,6 +55132,10 @@ public enum StaffMemberPermission /// MARKETING_SECTION, /// + ///The staff member can merge customers. + /// + MERGE_CUSTOMERS, + /// ///The staff member can view, create, update, delete, and cancel orders, and receive order notifications. The staff member can still create draft orders without this permission. /// ORDERS, @@ -54802,6 +55164,10 @@ public enum StaffMemberPermission /// REPORTS, /// + ///The staff member can request customer private data. + /// + REQUEST_CUSTOMER_DATA, + /// ///The staff member can view, update, and publish themes. /// THEMES, @@ -55169,15 +55535,15 @@ public class StandardMetafieldDefinitionTemplate : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in StandardMetafieldDefinitionTemplateEdge. + ///A list of nodes that are contained in StandardMetafieldDefinitionTemplateEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -55188,7 +55554,7 @@ public class StandardMetafieldDefinitionTemplateConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -55255,15 +55621,15 @@ public class StoreCreditAccount : GraphQLObject, INode public class StoreCreditAccountConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in StoreCreditAccountEdge. + ///A list of nodes that are contained in StoreCreditAccountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -55496,7 +55862,7 @@ public enum StoreCreditAccountDebitUserErrorCode public class StoreCreditAccountEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -55573,15 +55939,15 @@ public interface IStoreCreditAccountTransaction : IGraphQLObject public class StoreCreditAccountTransactionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in StoreCreditAccountTransactionEdge. + ///A list of nodes that are contained in StoreCreditAccountTransactionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -55592,7 +55958,7 @@ public class StoreCreditAccountTransactionConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -55603,8 +55969,12 @@ public class StoreCreditAccountTransactionEdge : GraphQLObject ///A token that's used to delegate unauthenticated access scopes to clients that need to access - ///the unauthenticated Storefront API. An app can have a maximum of 100 active storefront access + ///the unauthenticated [Storefront API](https://shopify.dev/docs/api/storefront). + /// + ///An app can have a maximum of 100 active storefront access ///tokens for each shop. + /// + ///[Get started with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/getting-started). /// public class StorefrontAccessToken : GraphQLObject, INode { @@ -55640,15 +56010,15 @@ public class StorefrontAccessToken : GraphQLObject, INode public class StorefrontAccessTokenConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in StorefrontAccessTokenEdge. + ///A list of nodes that are contained in StorefrontAccessTokenEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -55693,7 +56063,7 @@ public class StorefrontAccessTokenDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -55712,7 +56082,7 @@ public class StringConnection : GraphQLObject, IConnectionWith /// public IEnumerable? edges { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -55723,7 +56093,7 @@ public class StringConnection : GraphQLObject, IConnectionWith public class StringEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -55812,15 +56182,15 @@ public class SubscriptionBillingAttempt : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SubscriptionBillingAttemptEdge. + ///A list of nodes that are contained in SubscriptionBillingAttemptEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -55846,7 +56216,7 @@ public class SubscriptionBillingAttemptCreatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -56157,15 +56527,15 @@ public class SubscriptionBillingCycleChargePayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SubscriptionBillingCycleEdge. + ///A list of nodes that are contained in SubscriptionBillingCycleEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -56221,7 +56591,7 @@ public class SubscriptionBillingCycleContractEditPayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -56830,15 +57200,15 @@ public class SubscriptionContractCancelPayload : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SubscriptionContractEdge. + ///A list of nodes that are contained in SubscriptionContractEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -56864,7 +57234,7 @@ public class SubscriptionContractCreatePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -57372,15 +57742,15 @@ public class SubscriptionDiscountAllocation : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SubscriptionDiscountEdge. + ///A list of nodes that are contained in SubscriptionDiscountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -57391,7 +57761,7 @@ public class SubscriptionDiscountConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -58103,15 +58473,15 @@ public class SubscriptionLine : GraphQLObject public class SubscriptionLineConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SubscriptionLineEdge. + ///A list of nodes that are contained in SubscriptionLineEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -58122,7 +58492,7 @@ public class SubscriptionLineConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -58274,15 +58644,15 @@ public class SubscriptionManualDiscount : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in SubscriptionManualDiscountEdge. + ///A list of nodes that are contained in SubscriptionManualDiscountEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -58293,7 +58663,7 @@ public class SubscriptionManualDiscountConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -59154,15 +59524,15 @@ public interface ITaxonomyCategoryAttribute : IGraphQLObject public class TaxonomyCategoryAttributeConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in TaxonomyCategoryAttributeEdge. + ///A list of nodes that are contained in TaxonomyCategoryAttributeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -59173,7 +59543,7 @@ public class TaxonomyCategoryAttributeConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -59188,15 +59558,15 @@ public class TaxonomyCategoryAttributeEdge : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in TaxonomyCategoryEdge. + ///A list of nodes that are contained in TaxonomyCategoryEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -59207,7 +59577,7 @@ public class TaxonomyCategoryConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -59275,15 +59645,15 @@ public class TaxonomyValue : GraphQLObject, INode, IMetafieldRefe public class TaxonomyValueConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in TaxonomyValueEdge. + ///A list of nodes that are contained in TaxonomyValueEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -59294,7 +59664,7 @@ public class TaxonomyValueConnection : GraphQLObject, I public class TaxonomyValueEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -59350,15 +59720,15 @@ public class TenderTransaction : GraphQLObject, INode public class TenderTransactionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in TenderTransactionEdge. + ///A list of nodes that are contained in TenderTransactionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -59402,7 +59772,7 @@ public interface ITenderTransactionDetails : IGraphQLObject public class TenderTransactionEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -59610,7 +59980,7 @@ public class TranslatableResource : GraphQLObject /// public IEnumerable? translatableContent { get; set; } /// - ///Translatable content translations. + ///Translatable content translations (includes unpublished locales). /// public IEnumerable? translations { get; set; } } @@ -59621,15 +59991,15 @@ public class TranslatableResource : GraphQLObject public class TranslatableResourceConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in TranslatableResourceEdge. + ///A list of nodes that are contained in TranslatableResourceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -59640,7 +60010,7 @@ public class TranslatableResourceConnection : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -59844,6 +60214,7 @@ public enum TranslationErrorCode /// ///The locale is missing on the market corresponding to the `marketId` argument. /// + [Obsolete("`invalid_locale_for_market` is deprecated because the creation of a locale that's specific to a market no longer needs to be tied to that market's URL.")] INVALID_LOCALE_FOR_MARKET, /// ///The handle is already taken for this resource. @@ -60033,6 +60404,10 @@ public class UnverifiedReturnLineItem : GraphQLObject, ///Additional information about the reason for the return. Maximum length: 255 characters. /// public string? returnReasonNote { get; set; } + /// + ///The unit price of the unverified return line item. + /// + public MoneyV2? unitPrice { get; set; } } /// @@ -60216,15 +60591,15 @@ public enum UrlRedirectBulkDeleteBySearchUserErrorCode public class UrlRedirectConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in UrlRedirectEdge. + ///A list of nodes that are contained in UrlRedirectEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -60265,7 +60640,7 @@ public class UrlRedirectDeletePayload : GraphQLObject public class UrlRedirectEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -60518,15 +60893,20 @@ public class Validation : GraphQLObject, IHasMetafieldDefinitions, I /// public string? id { get; set; } /// - ///Returns a metafield by namespace and key that belongs to the resource. + ///A [custom field](https://shopify.dev/docs/apps/build/custom-data), + ///including its `namespace` and `key`, that's associated with a Shopify resource + ///for the purposes of adding and storing additional information. /// public Metafield? metafield { get; set; } + /// ///List of metafield definitions. /// + [Obsolete("This field will be removed in a future version. Use the root `metafieldDefinitions` field instead.")] public MetafieldDefinitionConnection? metafieldDefinitions { get; set; } /// - ///List of metafields that belong to the resource. + ///A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) + ///that a merchant associates with a Shopify resource. /// public MetafieldConnection? metafields { get; set; } @@ -60557,15 +60937,15 @@ public class Validation : GraphQLObject, IHasMetafieldDefinitions, I public class ValidationConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in ValidationEdge. + ///A list of nodes that are contained in ValidationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -60606,7 +60986,7 @@ public class ValidationDeletePayload : GraphQLObject public class ValidationEdge : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -61054,7 +61434,7 @@ public class WebhookSubscription : GraphQLObject, ILegacyIn /// public IWebhookSubscriptionEndpoint? endpoint { get; set; } /// - ///A constraint specified using search syntax that ensures only webhooks that match the specified filter are emitted. + ///A constraint specified using search syntax that ensures only webhooks that match the specified filter are emitted. See our [guide on filters](https://shopify.dev/docs/apps/build/webhooks/customize/filters) for more details. /// public string? filter { get; set; } /// @@ -61099,15 +61479,15 @@ public class WebhookSubscription : GraphQLObject, ILegacyIn public class WebhookSubscriptionConnection : GraphQLObject, IConnectionWithNodesAndEdges { /// - ///A list of edges. + ///The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. /// public IEnumerable? edges { get; set; } /// - ///A list of the nodes contained in WebhookSubscriptionEdge. + ///A list of nodes that are contained in WebhookSubscriptionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. /// public IEnumerable? nodes { get; set; } /// - ///Information to aid in pagination. + ///An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. /// public PageInfo? pageInfo { get; set; } } @@ -61148,7 +61528,7 @@ public class WebhookSubscriptionDeletePayload : GraphQLObject, IEdge { /// - ///A cursor for use in pagination. + ///The position of each node in an array, used in [pagination](https://shopify.dev/api/usage/pagination-graphql). /// public string? cursor { get; set; } /// @@ -61470,7 +61850,7 @@ public enum WebhookSubscriptionTopic /// FULFILLMENT_ORDERS_CANCELLATION_REQUEST_REJECTED, /// - ///The webhook topic for `fulfillment_orders/fulfillment_request_submitted` events. Occurs when a merchant submits a fulfillment request to a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_buyer_membership_orders, read_marketplace_fulfillment_orders. + ///The webhook topic for `fulfillment_orders/fulfillment_request_submitted` events. Occurs when a merchant submits a fulfillment request to a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_marketplace_fulfillment_orders. /// FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_SUBMITTED, /// @@ -61518,15 +61898,15 @@ public enum WebhookSubscriptionTopic /// SCHEDULED_PRODUCT_LISTINGS_REMOVE, /// - ///The webhook topic for `product_publications/create` events. Occurs whenever a product publication for an active product is created, or whenever an existing product publication is published. Requires the `read_publications` scope. + ///The webhook topic for `product_publications/create` events. Occurs whenever a product publication for an active product is created, or whenever an existing product publication is published on the app that is subscribed to this webhook topic. Note that a webhook is only emitted when there are publishing changes to the app that is subscribed to the topic (ie. no webhook will be emitted if there is a publishing change to the online store and the webhook subscriber of the topic is a third-party app). Requires the `read_publications` scope. /// PRODUCT_PUBLICATIONS_CREATE, /// - ///The webhook topic for `product_publications/delete` events. Occurs whenever a product publication for an active product is removed, or whenever an existing product publication is unpublished. Requires the `read_publications` scope. + ///The webhook topic for `product_publications/delete` events. Occurs whenever a product publication for an active product is removed, or whenever an existing product publication is unpublished from the app that is subscribed to this webhook topic. Note that a webhook is only emitted when there are publishing changes to the app that is subscribed to the topic (ie. no webhook will be emitted if there is a publishing change to the online store and the webhook subscriber of the topic is a third-party app). Requires the `read_publications` scope. /// PRODUCT_PUBLICATIONS_DELETE, /// - ///The webhook topic for `product_publications/update` events. Occurs whenever a product publication is updated. Requires the `read_publications` scope. + ///The webhook topic for `product_publications/update` events. Occurs whenever a product publication is updated from the app that is subscribed to this webhook topic. Note that a webhook is only emitted when there are publishing changes to the app that is subscribed to the topic (ie. no webhook will be emitted if there is a publishing change to the online store and the webhook subscriber of the topic is a third-party app). Requires the `read_publications` scope. /// PRODUCT_PUBLICATIONS_UPDATE, /// @@ -61538,7 +61918,7 @@ public enum WebhookSubscriptionTopic /// PRODUCTS_DELETE, /// - ///The webhook topic for `products/update` events. Occurs whenever a product is updated, or whenever a product is ordered, or whenever a variant is added, removed, or updated. Requires the `read_products` scope. + ///The webhook topic for `products/update` events. Occurs whenever a product is updated, ordered, or variants are added, removed or updated. Requires the `read_products` scope. /// PRODUCTS_UPDATE, ///