Skip to content

Instantly share code, notes, and snippets.

@sonatard
Last active March 11, 2022 05:13
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sonatard/16536df80d8f6df67b8a24f4efbf5615 to your computer and use it in GitHub Desktop.
Save sonatard/16536df80d8f6df67b8a24f4efbf5615 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
{
"data": {
"__schema": {
"queryType": {
"name": "QueryRoot"
},
"mutationType": {
"name": "Mutation"
},
"subscriptionType": null,
"types": [
{
"kind": "SCALAR",
"name": "ARN",
"description": "An Amazon Web Services Amazon Resource Name (ARN), including the Region and account ID.\nFor more information, refer to [Amazon Resource Names](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccessScope",
"description": "Represents the permission required to access a Shopify Admin API or Storefront API resource for a shop. Access scopes are granted by merchants to requesting applications.\n",
"fields": [
{
"name": "description",
"description": "Description of the resource access provided by the access scope when granted to an application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "handle",
"description": "Represents the access scope as a readable string. Typically follows the format `{action}_{resource}`: a `read` or `write` action, followed by the resource on which the action is allowed to be performed on, separated by an underscore. For example, `read_orders`; `write_products`.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AdjustmentSale",
"description": "A sale associated with an order price adjustment.",
"fields": [
{
"name": "actionType",
"description": "The type of order action that the sale represents.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "SaleActionType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The unique identifier for the sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineType",
"description": "The line type assocated with the sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "SaleLineType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of units either ordered or intended to be returned.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxes",
"description": "All individual taxes associated with the sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SaleTax",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalAmount",
"description": "The total sale amount after taxes and discounts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalDiscountAmountAfterTaxes",
"description": "The total discounts allocated to the sale after taxes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalDiscountAmountBeforeTaxes",
"description": "The total discounts allocated to the sale before taxes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalTaxAmount",
"description": "The total amount of taxes for the sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Sale",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AllDiscountItems",
"description": "Whether all items in the cart are entitled to the discount.",
"fields": [
{
"name": "allItems",
"description": "Whether all items are selected. The value is hardcoded to `true`.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ApiVersion",
"description": "A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).\nVersions are commonly referred to by their handle (for example, `2021-10`).\n",
"fields": [
{
"name": "displayName",
"description": "The human-readable name of the version.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "handle",
"description": "The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "supported",
"description": "Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "App",
"description": "A Shopify application.",
"fields": [
{
"name": "apiKey",
"description": "A unique application API identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appStoreAppUrl",
"description": "App store page URL of the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appStoreDeveloperUrl",
"description": "App store page URL of the developer who created the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "banner",
"description": "Banner image for the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "developerName",
"description": "The name of the app developer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "developerUrl",
"description": "Website of the developer who created the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `appStoreDeveloperUrl` instead"
},
{
"name": "embedded",
"description": "Whether the app uses the Embedded App SDK.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "failedRequirements",
"description": "Requirements that must be met before the app can be installed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "FailedRequirement",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "features",
"description": "A list of app features that are shown in the Shopify App Store listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "feedback",
"description": "Feedback from this app about the store.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppFeedback",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "handle",
"description": "Handle of the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "icon",
"description": "Icon that represents the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "installUrl",
"description": "Webpage where you can install the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "installation",
"description": "Corresponding AppInstallation for this shop and App.\nReturns null if the App is not installed.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPostPurchaseAppInUse",
"description": "Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "launchUrl",
"description": "Webpage that the app starts in.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use AppInstallation.launchUrl instead"
},
{
"name": "navigationItems",
"description": "Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "NavigationItem",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "Use AppInstallation.navigationItems instead"
},
{
"name": "pricingDetails",
"description": "Detailed information about the app pricing.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pricingDetailsSummary",
"description": "Summary of the app pricing details.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privacyPolicyUrl",
"description": "Link to app privacy policy.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "published",
"description": "Whether the app is published to the Shopify App Store.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "screenshots",
"description": "Screenshots of the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopifyDeveloped",
"description": "Whether the app was developed by Shopify.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "Name of the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "uninstallMessage",
"description": "Message that appears when the app is uninstalled. For example:\nBy removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "uninstallUrl",
"description": "Webpage where you can uninstall the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use AppInstallation.uninstallUrl instead"
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppConnection",
"description": "An auto-generated type for paginating through multiple Apps.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppCredit",
"description": "App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify.",
"fields": [
{
"name": "amount",
"description": "The amount that can be used towards future app purchases in Shopify.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the app credit was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of the app credit.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "test",
"description": "Whether the app credit is a test transaction.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppCreditConnection",
"description": "An auto-generated type for paginating through multiple AppCredits.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppCreditEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppCreditCreatePayload",
"description": "Return type for `appCreditCreate` mutation.",
"fields": [
{
"name": "appCredit",
"description": "The newly created app credit.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppCredit",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppCreditEdge",
"description": "An auto-generated type which holds one AppCredit and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of AppCreditEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppCredit",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppEdge",
"description": "An auto-generated type which holds one App and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of AppEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppFeedback",
"description": "Reports the status of shops and their resources and displays this information\nwithin Shopify admin. AppFeedback is used to notify merchants about steps they need to take\nto set up an app on their store.\n",
"fields": [
{
"name": "app",
"description": "The application associated to the feedback.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "link",
"description": "A link to where merchants can resolve errors.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Link",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "messages",
"description": "The feedback message presented to the merchant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppInstallation",
"description": "Represents an installed application on a shop.",
"fields": [
{
"name": "accessScopes",
"description": "The access scopes granted to the application by a merchant during installation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccessScope",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "activeSubscriptions",
"description": "The active application subscriptions billed to the shop on a recurring basis.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppSubscription",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "allSubscriptions",
"description": "All subscriptions created for a shop.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "AppSubscriptionSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppSubscriptionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "app",
"description": "Application which is installed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Channel associated with the installed application.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `publication` instead"
},
{
"name": "credits",
"description": "Credits that can be used towards future app purchases.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "AppTransactionSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppCreditConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "launchUrl",
"description": "The URL to launch the application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneTimePurchases",
"description": "One-time purchases to a shop.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "AppTransactionSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppPurchaseOneTimeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publication",
"description": "The publication associated with the installed application.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Publication",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "revenueAttributionRecords",
"description": "The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "AppRevenueAttributionRecordSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subscriptions",
"description": "Subscriptions charge to a shop on a recurring basis.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppSubscription",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "Use `activeSubscriptions` instead"
},
{
"name": "uninstallUrl",
"description": "The URL to uninstall the application.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppInstallationCategory",
"description": "The possible categories of an app installation, based on their purpose\nor the environment they can run in.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CHANNEL",
"description": "Apps that serve as channels through which sales are made, such as the online store.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "POS_EMBEDDED",
"description": "Apps that can be used in the POS mobile client.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppInstallationConnection",
"description": "An auto-generated type for paginating through multiple AppInstallations.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppInstallationEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppInstallationEdge",
"description": "An auto-generated type which holds one AppInstallation and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of AppInstallationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppInstallationPrivacy",
"description": "The levels of privacy of an app installation.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PUBLIC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRIVATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppInstallationSortKeys",
"description": "The set of valid sort keys for the AppInstallation query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INSTALLED_AT",
"description": "Sort by the `installed_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_TITLE",
"description": "Sort by the `app_title` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppPlanInput",
"description": "The pricing model for the app subscription.\nThe pricing model input can be either `appRecurringPricingDetails` or `appUsagePricingDetails`.\n",
"fields": null,
"inputFields": [
{
"name": "appUsagePricingDetails",
"description": "The pricing details for usage-based billing.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AppUsagePricingInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "appRecurringPricingDetails",
"description": "The pricing details for recurring billing.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AppRecurringPricingInput",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppPlanV2",
"description": "The app plan that the merchant is subscribed to.",
"fields": [
{
"name": "pricingDetails",
"description": "The plan billed to a shop on a recurring basis.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "AppPricingDetails",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "AppPricingDetails",
"description": "The information about the price that's charged to a shop every plan period.\nThe concrete type can be `AppRecurringPricing` for recurring billing or `AppUsagePricing` for usage-based billing.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AppRecurringPricing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppUsagePricing",
"ofType": null
}
]
},
{
"kind": "ENUM",
"name": "AppPricingInterval",
"description": "The frequency at which the shop is billed for an app subscription.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ANNUAL",
"description": "The app subscription bills the shop annually.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EVERY_30_DAYS",
"description": "The app subscription bills the shop every 30 days.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "AppPurchase",
"description": "Services and features purchased once by the store.",
"fields": [
{
"name": "createdAt",
"description": "The date and time when the app purchase occurred.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the app purchase.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The amount to be charged to the store for the app purchase.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the app purchase.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppPurchaseStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "test",
"description": "Whether the app purchase is a test transaction.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AppPurchaseOneTime",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "AppPurchaseOneTime",
"description": "Services and features purchased once by a store.",
"fields": [
{
"name": "createdAt",
"description": "The date and time when the app purchase occurred.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the app purchase.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The amount to be charged to the store for the app purchase.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the app purchase.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppPurchaseStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "test",
"description": "Whether the app purchase is a test transaction.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "AppPurchase",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppPurchaseOneTimeConnection",
"description": "An auto-generated type for paginating through multiple AppPurchaseOneTimes.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppPurchaseOneTimeEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppPurchaseOneTimeCreatePayload",
"description": "Return type for `appPurchaseOneTimeCreate` mutation.",
"fields": [
{
"name": "appPurchaseOneTime",
"description": "The newly created app one-time purchase.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppPurchaseOneTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "confirmationUrl",
"description": "The URL that the merchant can access to approve or decline the newly created app one-time purchase.\n\nIf the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined.\nIf the merchant approves and they're successfully invoiced, then the state of the charge changes from `pending` to `active`.\n\nYou get paid after the charge is activated.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppPurchaseOneTimeEdge",
"description": "An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of AppPurchaseOneTimeEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppPurchaseOneTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppPurchaseStatus",
"description": "The approval status of the app purchase.\n\nThe merchant is charged for the purchase immediately after approval, and the status changes to `active`.\nIf the payment fails, then the app purchase remains `pending`.\n\nPurchases start as `pending` and can change to: `active`, `declined`, `expired`. After a purchase changes, it\nremains in that final state.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCEPTED",
"description": "The app purchase has been approved by the merchant and is ready to be activated by the app. App purchases created through the GraphQL Admin API are activated upon approval.",
"isDeprecated": true,
"deprecationReason": "As of API version 2021-01, when a merchant accepts an app purchase, the status immediately changes from `pending` to `active`."
},
{
"name": "ACTIVE",
"description": "The app purchase was approved by the merchant and has been activated by the app. Active app purchases are charged to the merchant and are paid out to the partner.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DECLINED",
"description": "The app purchase was declined by the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": "The app purchase was not accepted within two days of being created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PENDING",
"description": "The app purchase is pending approval by the merchant.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRecurringPricing",
"description": "The pricing information about a subscription app.\nThe object contains an interval (the frequency at which the shop is billed for an app subscription) and\na price (the amount to be charged to the subscribing shop at each interval).\n",
"fields": [
{
"name": "interval",
"description": "The frequency at which the subscribing shop is billed for an app subscription.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppPricingInterval",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The amount and currency to be charged to the subscribing shop every billing interval.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppRecurringPricingInput",
"description": "Instructs the app subscription to generate a fixed charge on a recurring basis. The frequency is specified by the billing interval.",
"fields": null,
"inputFields": [
{
"name": "interval",
"description": "How often the app subscription generates a charge.",
"type": {
"kind": "ENUM",
"name": "AppPricingInterval",
"ofType": null
},
"defaultValue": "EVERY_30_DAYS"
},
{
"name": "price",
"description": "The amount to be charged to the store every billing interval. The only permitted currency code is USD.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRevenueAttributionRecord",
"description": "Represents app revenue that was captured externally by the partner.",
"fields": [
{
"name": "amount",
"description": "The financial amount captured in this attribution.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "capturedAt",
"description": "The timestamp when the financial amount was captured.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The timestamp at which this revenue attribution was issued.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "idempotencyKey",
"description": "The unique value submitted during the creation of the app revenue attribution record.\nFor more information, refer to\n[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "test",
"description": "Indicates whether this is a test submission.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of revenue attribution.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppRevenueAttributionType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordConnection",
"description": "An auto-generated type for paginating through multiple AppRevenueAttributionRecords.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordCreatePayload",
"description": "Return type for `appRevenueAttributionRecordCreate` mutation.",
"fields": [
{
"name": "appRevenueAttributionRecord",
"description": "The created app revenue attribution record.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppRevenueAttributionRecord",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordCreateUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordCreateUserError",
"description": "An error that occurs during the execution of `AppRevenueAttributionRecordCreate`.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AppRevenueAttributionRecordCreateUserErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppRevenueAttributionRecordCreateUserErrorCode",
"description": "Possible error codes that can be returned by `AppRevenueAttributionRecordCreateUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INVALID",
"description": "The input value is invalid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAKEN",
"description": "The input value is already taken.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordDeletePayload",
"description": "Return type for `appRevenueAttributionRecordDelete` mutation.",
"fields": [
{
"name": "deletedId",
"description": "The ID of the revenue attribution that was deleted, if one was.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordDeleteUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordDeleteUserError",
"description": "An error that occurs during the execution of `AppRevenueAttributionRecordDelete`.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AppRevenueAttributionRecordDeleteUserErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppRevenueAttributionRecordDeleteUserErrorCode",
"description": "Possible error codes that can be returned by `AppRevenueAttributionRecordDeleteUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INVALID",
"description": "The input value is invalid.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRevenueAttributionRecordEdge",
"description": "An auto-generated type which holds one AppRevenueAttributionRecord and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of AppRevenueAttributionRecordEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppRevenueAttributionRecord",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppRevenueAttributionRecordInput",
"description": "Allows to supply an app revenue attribution record.",
"fields": null,
"inputFields": [
{
"name": "idempotencyKey",
"description": "The unique value submitted during creation.\nFor more information, refer to\n[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).\n",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "capturedAt",
"description": "The timestamp when the financial amount was captured.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "amount",
"description": "The financial amount captured in this attribution.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "type",
"description": "The type of revenue attribution.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppRevenueAttributionType",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "test",
"description": "Indicates whether this is a test submission.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppRevenueAttributionRecordSortKeys",
"description": "The set of valid sort keys for the AppRevenueAttributionRecord query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppRevenueAttributionType",
"description": "Represents the billing types of revenue attribution.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "APPLICATION_PURCHASE",
"description": "App purchase related revenue collection.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APPLICATION_SUBSCRIPTION",
"description": "App subscription revenue collection.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APPLICATION_USAGE",
"description": "App usage-based revenue collection.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OTHER",
"description": "Other app revenue collection type.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppSubscription",
"description": "Provides users access to services and/or features for a duration of time.",
"fields": [
{
"name": "createdAt",
"description": "The date and time when the app subscription was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currentPeriodEnd",
"description": "The date and time when the current app subscription period ends.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineItems",
"description": "The plans attached to the app subscription.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppSubscriptionLineItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the app subscription.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "returnUrl",
"description": "The URL that the merchant is redirected to after approving the app subscription.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the app subscription.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppSubscriptionStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "test",
"description": "Specifies whether the app subscription is a test transaction.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trialDays",
"description": "The number of free trial days, starting at the subscription's creation date, by which billing is delayed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppSubscriptionCancelPayload",
"description": "Return type for `appSubscriptionCancel` mutation.",
"fields": [
{
"name": "appSubscription",
"description": "The cancelled app subscription.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppSubscription",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppSubscriptionConnection",
"description": "An auto-generated type for paginating through multiple AppSubscriptions.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppSubscriptionEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppSubscriptionCreatePayload",
"description": "Return type for `appSubscriptionCreate` mutation.",
"fields": [
{
"name": "appSubscription",
"description": "The newly-created app subscription.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppSubscription",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "confirmationUrl",
"description": "The URL pointing to the page where the merchant approves or declines the charges for an app subscription.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppSubscriptionEdge",
"description": "An auto-generated type which holds one AppSubscription and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of AppSubscriptionEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppSubscription",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppSubscriptionLineItem",
"description": "The plan attached to an app subscription.",
"fields": [
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plan",
"description": "The pricing model for the app subscription.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppPlanV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageRecords",
"description": "A list of the store's usage records for a usage pricing plan.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "AppUsageRecordSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppUsageRecordConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppSubscriptionLineItemInput",
"description": "Allows an app to add more than one pricing plan to an app subscription.",
"fields": null,
"inputFields": [
{
"name": "plan",
"description": "The pricing model for the app subscription.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AppPlanInput",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppSubscriptionLineItemUpdatePayload",
"description": "Return type for `appSubscriptionLineItemUpdate` mutation.",
"fields": [
{
"name": "appSubscription",
"description": "The updated app subscription.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppSubscription",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "confirmationUrl",
"description": "The URL where the merchant approves or declines the updated app subscription line item.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppSubscriptionSortKeys",
"description": "The set of valid sort keys for the AppSubscription query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppSubscriptionStatus",
"description": "The status of the app subscription.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PENDING",
"description": "The app subscription is pending approval by the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCEPTED",
"description": "The app subscription has been approved by the merchant and is ready to be activated by the app.",
"isDeprecated": true,
"deprecationReason": "As of API version 2021-01, when a merchant approves an app subscription, the status immediately transitions from `pending` to `active`."
},
{
"name": "ACTIVE",
"description": "The app subscription has been approved by the merchant. Active app subscriptions are billed to the shop. After payment, partners receive payouts.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DECLINED",
"description": "The app subscription was declined by the merchant. This is a terminal state.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": "The app subscription wasn't accepted within two days of being created. This is a terminal state.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FROZEN",
"description": "The app subscription is on hold due to non-payment. The subscription re-activates after payments resume.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCELLED",
"description": "The app subscription was cancelled by the app. This could be caused by the app being uninstalled, a new app subscription being activated, or a direct cancellation by the app. This is a terminal state.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppTransactionSortKeys",
"description": "The set of valid sort keys for the AppTransaction query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppUsagePricing",
"description": "Defines a usage pricing model for the app subscription.\nThese charges are variable based on how much the merchant uses the app.\n",
"fields": [
{
"name": "balanceUsed",
"description": "The total usage records for interval.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cappedAmount",
"description": "The capped amount prevents the merchant from being charged for any usage over that amount during a billing period.\nThis prevents billing from exceeding a maximum threshold over the duration of the billing period.\nFor the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "interval",
"description": "The frequency with which the app usage records are billed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppPricingInterval",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "terms",
"description": "The terms and conditions for app usage pricing.\nMust be present in order to create usage charges.\nThe terms are presented to the merchant when they approve an app's usage charges.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppUsagePricingInput",
"description": "Allows an app to issue arbitrary charges for app usage associated with a subscription.",
"fields": null,
"inputFields": [
{
"name": "cappedAmount",
"description": "The maximum amount of usage charges that can be incurred within a subscription billing interval.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "terms",
"description": "The terms and conditions for app usage. These terms stipulate the pricing model for the charges that an app creates.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppUsageRecord",
"description": "Store usage for app subscriptions with usage pricing.",
"fields": [
{
"name": "createdAt",
"description": "The date and time when the usage record was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of the app usage record.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The price of the usage record. The only permitted currency code is USD.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subscriptionLineItem",
"description": "Defines the usage pricing plan the merchant is subscribed to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppSubscriptionLineItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppUsageRecordConnection",
"description": "An auto-generated type for paginating through multiple AppUsageRecords.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppUsageRecordEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppUsageRecordCreatePayload",
"description": "Return type for `appUsageRecordCreate` mutation.",
"fields": [
{
"name": "appUsageRecord",
"description": "The newly created app usage record.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppUsageRecord",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppUsageRecordEdge",
"description": "An auto-generated type which holds one AppUsageRecord and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of AppUsageRecordEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppUsageRecord",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppUsageRecordSortKeys",
"description": "The set of valid sort keys for the AppUsageRecord query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Attribute",
"description": "Represents a generic custom attribute.",
"fields": [
{
"name": "key",
"description": "Key or name of the attribute.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of the attribute.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeInput",
"description": "Specifies the input fields required for an attribute.",
"fields": null,
"inputFields": [
{
"name": "key",
"description": "Key or name of the attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "value",
"description": "Value of the attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AutomaticDiscountApplication",
"description": "Automatic discount applications capture the intentions of a discount that was automatically applied.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "index",
"description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DiscountApplication",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AutomaticDiscountSortKeys",
"description": "The set of valid sort keys for the AutomaticDiscount query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BasicEvent",
"description": "Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or\nthe addition of a product.\n",
"fields": [
{
"name": "appTitle",
"description": "The name of the app that created the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeToApp",
"description": "Whether the event was created by an app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeToUser",
"description": "Whether the event was caused by an admin user.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the event was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "criticalAlert",
"description": "Whether the event is critical.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Human readable text that describes the event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "FormattedString",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BillingAttemptUserError",
"description": "Represents an error that happens during the execution of a billing attempt mutation.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "BillingAttemptUserErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BillingAttemptUserErrorCode",
"description": "Possible error codes that can be returned by `BillingAttemptUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INVALID",
"description": "The input value is invalid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BLANK",
"description": "The input value is blank.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONTRACT_NOT_FOUND",
"description": "Subscription contract does not exist.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Boolean",
"description": "Represents `true` or `false` values.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BulkMutationErrorCode",
"description": "Possible error codes that can be returned by `BulkMutationUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "OPERATION_IN_PROGRESS",
"description": "The operation did not run because another bulk mutation is already running. [Wait for the operation to finish](https://shopify.dev/api/usage/bulk-operations/imports#wait-for-the-operation-to-finish) before retrying this operation.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_MUTATION",
"description": "The operation did not run because the mutation is invalid. Check your mutation syntax and try again.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_STAGED_UPLOAD_FILE",
"description": "The JSONL file submitted via the `stagedUploadsCreate` mutation is invalid. Update the file and try again.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_SUCH_FILE",
"description": "The JSONL file could not be found. Try [uploading the file](https://shopify.dev/api/usage/bulk-operations/imports#generate-the-uploaded-url-and-parameters) again, and check that you've entered the URL correctly for the `bulkOperationRunMutationUploadPath` mutation argument.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INTERNAL_FILE_SERVER_ERROR",
"description": "There was a problem reading the JSONL file. This error might be intermittent, so you can try performing the same query again.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkMutationUserError",
"description": "Represents an error that happens during execution of a bulk mutation.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "BulkMutationErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkOperation",
"description": "An asynchronous long-running operation to fetch data in bulk or to bulk import data.\n\nBulk operations are created using the `bulkOperationRunQuery` or `bulkOperationRunMutation` mutation. After\nthey are created, clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains\na link to the data in [JSONL](http://jsonlines.org/) format.\n\nRefer to the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details.\n",
"fields": [
{
"name": "completedAt",
"description": "When the bulk operation was successfully completed.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "When the bulk operation was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errorCode",
"description": "Error code for failed operations.",
"args": [],
"type": {
"kind": "ENUM",
"name": "BulkOperationErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fileSize",
"description": "File size in bytes of the file in the `url` field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "objectCount",
"description": "A running count of all the objects processed.\nFor example, when fetching all the products and their variants, this field counts both products and variants.\nThis field can be used to track operation progress.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "partialDataUrl",
"description": "The URL that points to the partial or incomplete response data (in [JSONL](http://jsonlines.org/) format) that was returned by a failed operation.\nThe URL expires 7 days after the operation fails. Returns `null` when there's no data available.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "GraphQL query document specified in `bulkOperationRunQuery`.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rootObjectCount",
"description": "A running count of all the objects that are processed at the root of the query.\nFor example, when fetching all the products and their variants, this field only counts products.\nThis field can be used to track operation progress.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Status of the bulk operation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "BulkOperationStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The bulk operation's type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "BulkOperationType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL that points to the response data in [JSONL](http://jsonlines.org/) format.\nThe URL expires 7 days after the operation completes.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkOperationCancelPayload",
"description": "Return type for `bulkOperationCancel` mutation.",
"fields": [
{
"name": "bulkOperation",
"description": "The bulk operation to be canceled.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "BulkOperation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BulkOperationErrorCode",
"description": "Error codes for failed bulk operations.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCESS_DENIED",
"description": "The provided operation `query` returned access denied due to missing\n[access scopes](https://shopify.dev/api/usage/access-scopes).\nReview the requested object permissions and execute the query as a normal non-bulk GraphQL request to see more details.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INTERNAL_SERVER_ERROR",
"description": "The operation resulted in partial or incomplete data due to internal server errors during execution.\nThese errors might be intermittent, so you can try performing the same query again.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TIMEOUT",
"description": "The operation resulted in partial or incomplete data due to query timeouts during execution.\nIn some cases, timeouts can be avoided by modifying your `query` to select fewer fields.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkOperationRunMutationPayload",
"description": "Return type for `bulkOperationRunMutation` mutation.",
"fields": [
{
"name": "bulkOperation",
"description": "The newly created bulk operation.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "BulkOperation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkMutationUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkOperationRunQueryPayload",
"description": "Return type for `bulkOperationRunQuery` mutation.",
"fields": [
{
"name": "bulkOperation",
"description": "The newly created bulk operation.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "BulkOperation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BulkOperationStatus",
"description": "The valid values for the status of a bulk operation.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANCELED",
"description": "The bulk operation has been canceled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCELING",
"description": "Cancelation has been initiated on the bulk operation. There may be a short delay from when a cancelation\nstarts until the operation is actually canceled.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COMPLETED",
"description": "The bulk operation has successfully completed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED",
"description": "The bulk operation has been created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": "The bulk operation URL has expired.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FAILED",
"description": "The bulk operation has failed. For information on why the operation failed, use\n[BulkOperation.errorCode](https://shopify.dev/api/admin-graphql/latest/enums/bulkoperationerrorcode).\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RUNNING",
"description": "The bulk operation is runnning.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BulkOperationType",
"description": "The valid values for the bulk operation's type.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "QUERY",
"description": "The bulk operation is a query.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MUTATION",
"description": "The bulk operation is a mutation.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkProductResourceFeedbackCreatePayload",
"description": "Return type for `bulkProductResourceFeedbackCreate` mutation.",
"fields": [
{
"name": "feedback",
"description": "The feedback that is created.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductResourceFeedback",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkProductResourceFeedbackCreateUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkProductResourceFeedbackCreateUserError",
"description": "An error that occurs during the execution of `BulkProductResourceFeedbackCreate`.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "BulkProductResourceFeedbackCreateUserErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BulkProductResourceFeedbackCreateUserErrorCode",
"description": "Possible error codes that can be returned by `BulkProductResourceFeedbackCreateUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MAXIMUM_FEEDBACK_LIMIT_EXCEEDED",
"description": "The operation was attempted on too many feedback objects. The maximum number of feedback objects that you can operate on is 50.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUTDATED_FEEDBACK",
"description": "The feedback for a later version of this resource was already accepted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_NOT_FOUND",
"description": "The product wasn't found or isn't available to the channel.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": "The input value is invalid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BLANK",
"description": "The input value is blank.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRESENT",
"description": "The input value needs to be blank.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LESS_THAN_OR_EQUAL_TO",
"description": "The input value should be less than or equal to the maximum value allowed.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedAutomaticDiscountApplication",
"description": "A discount that is automatically applied to an order that is being edited.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliedTo",
"description": "The level at which the discount was applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of discount application. Indicates the reason why the discount was applied.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "CalculatedDiscountApplication",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedDiscountAllocation",
"description": "An amount discounting the line that has been allocated by an associated discount application.\n",
"fields": [
{
"name": "allocatedAmountSet",
"description": "The money amount allocated by the discount application in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountApplication",
"description": "The discount that the allocated amount originated from.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "CalculatedDiscountApplication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "CalculatedDiscountApplication",
"description": "A [discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/discountapplication) involved in order editing that might be newly added or have new changes applied.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliedTo",
"description": "The level at which the discount was applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of discount application. Indicates the reason why the discount was applied.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "CalculatedAutomaticDiscountApplication",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CalculatedDiscountCodeApplication",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CalculatedManualDiscountApplication",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CalculatedScriptDiscountApplication",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "CalculatedDiscountApplicationConnection",
"description": "An auto-generated type for paginating through multiple CalculatedDiscountApplications.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedDiscountApplicationEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedDiscountApplicationEdge",
"description": "An auto-generated type which holds one CalculatedDiscountApplication and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CalculatedDiscountApplicationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "CalculatedDiscountApplication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedDiscountCodeApplication",
"description": "A discount code that is applied to an order that is being edited.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliedTo",
"description": "The level at which the discount was applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The string identifying the discount code that was used at the time of application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of discount application. Indicates the reason why the discount was applied.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "CalculatedDiscountApplication",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedDraftOrder",
"description": "The computed properties for a draft order.",
"fields": [
{
"name": "appliedDiscount",
"description": "Order-level discount applied to the draft order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DraftOrderAppliedDiscount",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableShippingRates",
"description": "The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingRate",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customer",
"description": "Customer who will be sent an invoice for the draft order, if there is one.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineItems",
"description": "Line items in the draft order with their computed properties.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedDraftOrderLineItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingLine",
"description": "Line item that contains the shipping costs.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subtotalPrice",
"description": "Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes).\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxLines",
"description": "Total amount of taxes charged for each line item and shipping line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxLine",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPrice",
"description": "Total amount of the draft order (includes taxes, shipping charges, and discounts).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalShippingPrice",
"description": "Total shipping charge for the draft order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalTax",
"description": "Total amount of taxes for the draft order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedDraftOrderLineItem",
"description": "The computed line items for a draft order.",
"fields": [
{
"name": "appliedDiscount",
"description": "Discount applied to the line item.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DraftOrderAppliedDiscount",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "custom",
"description": "Indicates if this is a product variant line item, or a custom line item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customAttributes",
"description": "List of additional information about the line item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountedTotal",
"description": "Total price with discounts applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountedUnitPrice",
"description": "Unit price with discounts applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentService",
"description": "Name of the service provider who fulfilled the order.\n\nValid values are either **manual** or the name of the provider.\nFor example, **amazon**, **shipwire**.\n\nDeleted fulfillment services will return null.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "FulfillmentService",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "image",
"description": "Image associated with the draft order line item.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isGiftCard",
"description": "Indicates whether the line item represents the puchase of a gift card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "originalTotal",
"description": "Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "originalUnitPrice",
"description": "Variant price without any discounts applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "Product associated with the draft order line item.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Number of variant items requested in the draft order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiresShipping",
"description": "Whether physical shipping is required for the variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "Variant SKU number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxable",
"description": "Whether the variant is taxable.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "Title of the product or variant (this field only applies to custom line items).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalDiscount",
"description": "Total value of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variant",
"description": "Variant associated with the draft order line item.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantTitle",
"description": "Name of the variant.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "vendor",
"description": "Name of the vendor who made the variant.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight unit and value for a draft order line item.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedLineItem",
"description": "A line item involved in order editing that may be newly added or have new changes applied.\n",
"fields": [
{
"name": "calculatedDiscountAllocations",
"description": "The discounts that have been allocated onto the line item by discount applications.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedDiscountAllocation",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customAttributes",
"description": "The list of additional information about the line item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountAllocations",
"description": "The discounts that have been allocated onto the line item by discount applications.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountAllocation",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "Use `calculatedDiscountAllocations` instead"
},
{
"name": "discountedUnitPriceSet",
"description": "The price of a single quantity of the line item with line item discounts applied, in shop and presentment currencies. Discounts applied to the entire order aren't included in this price.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "editableQuantity",
"description": "The total number of items that can be edited.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "editableQuantityBeforeChanges",
"description": "The editable quantity prior to any changes made in the current edit.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "editableSubtotalSet",
"description": "The total price of editable lines in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasStagedLineItemDiscount",
"description": "Whether the calculated line item has a staged discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "image",
"description": "The image object associated to the line item's variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "originalUnitPriceSet",
"description": "The variant unit price in shop and presentment currencies, without any discounts applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The total number of items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restockable",
"description": "Whether the line item can be restocked or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restocking",
"description": "Whether the changes on the line item will result in a restock.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "The variant SKU number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stagedChanges",
"description": "A list of changes that affect this line item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "OrderStagedChange",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "uneditableSubtotalSet",
"description": "The total price of uneditable lines in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variant",
"description": "The product variant associated with this line item. The value is null for custom line items and items where\nthe variant has been deleted.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantTitle",
"description": "The title of the variant.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedLineItemConnection",
"description": "An auto-generated type for paginating through multiple CalculatedLineItems.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedLineItemEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedLineItemEdge",
"description": "An auto-generated type which holds one CalculatedLineItem and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CalculatedLineItemEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedLineItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedManualDiscountApplication",
"description": "Represents a discount that was manually created for an order that is being edited.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliedTo",
"description": "The level at which the discount was applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of discount application. Indicates the reason why the discount was applied.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "CalculatedDiscountApplication",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedOrder",
"description": "An order with edits applied but not saved.\n",
"fields": [
{
"name": "addedDiscountApplications",
"description": "Returns only the new discount applications being added to the order in the current edit.\n",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedDiscountApplicationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addedLineItems",
"description": "Returns only the new line items being added to the order during the current edit.\n",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedLineItemConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cartDiscountAmountSet",
"description": "Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "committed",
"description": "Whether the changes have been applied and saved to the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineItems",
"description": "Returns all items on the order that existed before starting the edit.\nWill include any changes that have been made.\nWill not include line items added during the current edit.\n",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `editable`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CalculatedLineItemConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "notificationPreviewHtml",
"description": "The HTML of the customer notification for the order edit.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "HTML",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "notificationPreviewTitle",
"description": "The customer notification title.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order without any changes applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `originalOrder` instead"
},
{
"name": "originalOrder",
"description": "The order without any changes applied.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stagedChanges",
"description": "List of changes made to the order during the current edit.\n",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderStagedChangeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subtotalLineItemsQuantity",
"description": "The sum of the quantities for the line items that contribute to the order's subtotal.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subtotalPriceSet",
"description": "The subtotal of the line items, in shop and presentment currencies, after all the discounts are applied. The subtotal does not include shipping. The subtotal includes taxes for taxes-included orders and excludes taxes for taxes-excluded orders.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxLines",
"description": "Taxes charged for the line item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxLine",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalOutstandingSet",
"description": "Total price of the order less the total amount received from the customer in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPriceSet",
"description": "Total amount of the order (includes taxes and discounts) in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculatedScriptDiscountApplication",
"description": "A discount created by a Shopify script for an order that is being edited.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliedTo",
"description": "The level at which the discount was applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of discount application. Indicates the reason why the discount was applied.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "CalculatedDiscountApplication",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Channel",
"description": "A channel represents an app where you sell a group of products and collections.\nA channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS.\n",
"fields": [
{
"name": "app",
"description": "Underlying app used by the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionPublicationsV3",
"description": "The collection publications for the list of collections published to the channel.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ResourcePublicationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "The list of collections published to the channel.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "handle",
"description": "Unique identifier for the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `id` instead"
},
{
"name": "hasCollection",
"description": "Whether the collection is available to the channel.",
"args": [
{
"name": "id",
"description": "Collection ID to check.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "navigationItems",
"description": "Menu items for the channel, which also appear as submenu items in left navigation sidebar in the Shopify admin.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "NavigationItem",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "Use App.navigationItems instead"
},
{
"name": "overviewPath",
"description": "Home page for the channel.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use App.launchUrl instead"
},
{
"name": "productPublications",
"description": "The product publications for the products published to the channel.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductPublicationConnection",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `productPublicationsV3` instead"
},
{
"name": "productPublicationsV3",
"description": "The product publications for the list of products published to the channel.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ResourcePublicationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "The list of products published to the channel.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "supportsFuturePublishing",
"description": "Whether or not this channel supports future publishing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelConnection",
"description": "An auto-generated type for paginating through multiple Channels.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelEdge",
"description": "An auto-generated type which holds one Channel and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of ChannelEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CodeDiscountSortKeys",
"description": "The set of valid sort keys for the CodeDiscount query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "STARTS_AT",
"description": "Sort by the `starts_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENDS_AT",
"description": "Sort by the `ends_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TITLE",
"description": "Sort by the `title` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATED_AT",
"description": "Sort by the `updated_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Collection",
"description": "Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.\n\nCollections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.\n\nCollections can also be created for a custom group of products. These are called custom or manual collections.\n",
"fields": [
{
"name": "availablePublicationCount",
"description": "The number of publications a resource is published to without feedback errors.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.\n",
"args": [
{
"name": "truncateAt",
"description": "Truncates string after the given length.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionHtml",
"description": "The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "HTML",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "feedback",
"description": "Information about the collection that's provided through resource feedback.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ResourceFeedback",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "handle",
"description": "A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title `Summer Catalog 2022` might have the handle `summer-catalog-2022`.\n\nIf the title is changed, the handle doesn't automatically change.\n\nThe handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasProduct",
"description": "Whether the collection includes the specified product.",
"args": [
{
"name": "id",
"description": "The ID of the product to check.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "image",
"description": "The image associated with the collection.",
"args": [
{
"name": "maxWidth",
"description": "Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "maxHeight",
"description": "Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "crop",
"description": "Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead.",
"type": {
"kind": "ENUM",
"name": "CropRegion",
"ofType": null
},
"defaultValue": null
},
{
"name": "scale",
"description": "Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": "1"
}
],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "legacyResourceId",
"description": "The ID of the corresponding resource in the REST Admin API.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "Returns a metafield by namespace and key that belongs to the resource.",
"args": [
{
"name": "namespace",
"description": "The namespace for the metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "The key for the metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Metafield",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafieldDefinitions",
"description": "List of metafield definitions.",
"args": [
{
"name": "namespace",
"description": "Filter metafield definitions by namespace.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "pinnedStatus",
"description": "Filter by the definition's pinned status.",
"type": {
"kind": "ENUM",
"name": "MetafieldDefinitionPinnedStatus",
"ofType": null
},
"defaultValue": "ANY"
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "MetafieldDefinitionSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetafieldDefinitionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "List of metafields that belong to the resource.",
"args": [
{
"name": "namespace",
"description": "The metafield namespace to filter by.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetafieldConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "Returns a private metafield by namespace and key that belongs to the resource.",
"args": [
{
"name": "namespace",
"description": "The namespace for the private metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "The key for the private metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "PrivateMetafield",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "List of private metafields that belong to the resource.",
"args": [
{
"name": "namespace",
"description": "Filter the private metafields by namespace.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PrivateMetafieldConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "The products that are included in the collection.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "ProductCollectionSortKeys",
"ofType": null
},
"defaultValue": "COLLECTION_DEFAULT"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productsCount",
"description": "The number of products in the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationCount",
"description": "The number of publications a resource is published on.",
"args": [
{
"name": "onlyPublished",
"description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publications",
"description": "The channels where the collection is published.",
"args": [
{
"name": "onlyPublished",
"description": "Whether or not to return only the collection publications that are published.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true"
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionPublicationConnection",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `resourcePublications` instead"
},
{
"name": "publishedOnChannel",
"description": "Check to see whether the resource is published to a given channel.",
"args": [
{
"name": "channelId",
"description": "The ID of the channel to check.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `publishedOnPublication` instead"
},
{
"name": "publishedOnCurrentChannel",
"description": "Check to see whether the resource is published to the calling app's channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `publishedOnCurrentPublication` instead"
},
{
"name": "publishedOnCurrentPublication",
"description": "Check to see whether the resource is published to the calling app's publication.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedOnPublication",
"description": "Check to see whether the resource is published to a given publication.",
"args": [
{
"name": "publicationId",
"description": "The ID of the publication to check.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "resourcePublications",
"description": "The list of resources that are published to a publication.",
"args": [
{
"name": "onlyPublished",
"description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.\n",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true"
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ResourcePublicationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "resourcePublicationsV2",
"description": "The list of resources that are either published or staged to be published to a publication.",
"args": [
{
"name": "onlyPublished",
"description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.\n",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true"
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ResourcePublicationV2Connection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ruleSet",
"description": "For a smart (automated) collection, specifies the rules that determine whether a product is included.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CollectionRuleSet",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "If the default SEO fields for page title and description have been modified, contains the modified information.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SEO",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortOrder",
"description": "The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionSortOrder",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storefrontId",
"description": "The Storefront GraphQL API ID of the `Collection`.\n\nAs of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "StorefrontID",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `id` instead"
},
{
"name": "templateSuffix",
"description": "The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template. If the value is `null`, then the collection is using the default `collection.liquid` template.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translations",
"description": "The translations associated with the resource.",
"args": [
{
"name": "locale",
"description": "Filters translations locale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PublishedTranslation",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unpublishedChannels",
"description": "The list of channels that the resource is not published to.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelConnection",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `unpublishedPublications` instead"
},
{
"name": "unpublishedPublications",
"description": "The list of publications that the resource is not published to.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PublicationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "HasMetafieldDefinitions",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasMetafields",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasPublishedTranslations",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Publishable",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionAddProductsPayload",
"description": "Return type for `collectionAddProducts` mutation.",
"fields": [
{
"name": "collection",
"description": "The updated collection.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionConnection",
"description": "An auto-generated type for paginating through multiple Collections.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionCreatePayload",
"description": "Return type for `collectionCreate` mutation.",
"fields": [
{
"name": "collection",
"description": "The collection that has been created.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionDeleteInput",
"description": "Specifies the collection to delete.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The ID of the collection to be deleted.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionDeletePayload",
"description": "Return type for `collectionDelete` mutation.",
"fields": [
{
"name": "deletedCollectionId",
"description": "The ID of the collection that was deleted.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "The shop associated with the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionEdge",
"description": "An auto-generated type which holds one Collection and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CollectionEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionInput",
"description": "Specifies the input fields required to create a collection.",
"fields": null,
"inputFields": [
{
"name": "descriptionHtml",
"description": "The description of the collection, in HTML format.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "handle",
"description": "A unique human-friendly string for the collection. Automatically generated from the collection's title.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "id",
"description": "Specifies the collection to update or create a new collection if absent.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "image",
"description": "The image associated with the collection.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ImageInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "products",
"description": "Initial list of collection products. Only valid with `productCreate` and without rules.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "publications",
"description": "Initial list of collection publications. Only valid with `productCreate`. This argument is deprecated: Use PublishablePublish instead.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionPublicationInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "privateMetafields",
"description": "The private metafields to associated with this product.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PrivateMetafieldInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "ruleSet",
"description": "The rules used to assign products to the collection.\n",
"type": {
"kind": "INPUT_OBJECT",
"name": "CollectionRuleSetInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "templateSuffix",
"description": "The theme template used when viewing the collection in a store.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "sortOrder",
"description": "The order in which the collection's products are sorted.",
"type": {
"kind": "ENUM",
"name": "CollectionSortOrder",
"ofType": null
},
"defaultValue": null
},
{
"name": "title",
"description": "Required for creating a new collection.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "metafields",
"description": "The metafields to associate with this collection.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetafieldInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "seo",
"description": "SEO information for the collection.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SEOInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "redirectNewHandle",
"description": "Indicates whether a redirect is required after a new handle has been provided.\nIf true, then the old handle is redirected to the new one automatically.\n",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionPublication",
"description": "Represents the publications where a collection is published.",
"fields": [
{
"name": "channel",
"description": "The channel where the collection will be published.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `publication` instead"
},
{
"name": "collection",
"description": "The collection to be published on the publication.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Whether the publication is published or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publication",
"description": "The publication where the collection will be published.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Publication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishDate",
"description": "The date that the publication was or is going to be published.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionPublicationConnection",
"description": "An auto-generated type for paginating through multiple CollectionPublications.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionPublicationEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionPublicationEdge",
"description": "An auto-generated type which holds one CollectionPublication and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CollectionPublicationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionPublication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionPublicationInput",
"description": "Specifies the publications to which a collection will be published.",
"fields": null,
"inputFields": [
{
"name": "publicationId",
"description": "The ID of the publication.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "channelId",
"description": "The ID of the channel. This argument is deprecated: Use publicationId instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "channelHandle",
"description": "This argument is deprecated: Use publicationId instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionPublishInput",
"description": "Specifies a collection to publish and the sales channels to publish it to.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The collection to create or update publications for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "collectionPublications",
"description": "The channels where the collection will be published.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionPublicationInput",
"ofType": null
}
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionPublishPayload",
"description": "Return type for `collectionPublish` mutation.",
"fields": [
{
"name": "collection",
"description": "The published collection.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionPublications",
"description": "The channels where the collection has been published.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionPublication",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "The shop associated with the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionRemoveProductsPayload",
"description": "Return type for `collectionRemoveProducts` mutation.",
"fields": [
{
"name": "job",
"description": "The asynchronous job removing the products.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionReorderProductsPayload",
"description": "Return type for `collectionReorderProducts` mutation.",
"fields": [
{
"name": "job",
"description": "The asynchronous job reordering the products.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionRule",
"description": "Represents at rule that's used to assign products to a collection.",
"fields": [
{
"name": "column",
"description": "The attribute that the rule focuses on (for example, `title` or `product_type`).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionRuleColumn",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "condition",
"description": "The value that the operator is applied to (for example, `Hats`).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "relation",
"description": "The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`).\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionRuleRelation",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionRuleColumn",
"description": "Specifies the property of a product being used to populate the smart collection.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "TAG",
"description": "The `tag` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TITLE",
"description": "The `title` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TYPE",
"description": "The `type` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VENDOR",
"description": "The `vendor` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_PRICE",
"description": "The `variant_price` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS_PRICE_REDUCED",
"description": "The `is_price_reduced` attribute, which is a Boolean type evaluated as `true` if a product has a `compare_at_price` set on any of its variants.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_COMPARE_AT_PRICE",
"description": "The `variant_compare_at_price` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_WEIGHT",
"description": "The `variant_weight` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_INVENTORY",
"description": "The `variant_inventory` attribute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_TITLE",
"description": "The `variant_title` attribute.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionRuleConditions",
"description": "Collections may use rules to automatically include the matching products. This defines restrictions for a type of rule.",
"fields": [
{
"name": "allowedRelations",
"description": "Allowed relations of the rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionRuleRelation",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultRelation",
"description": "Most commonly used relation for this rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionRuleRelation",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ruleType",
"description": "Type of the rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionRuleColumn",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionRuleInput",
"description": "Specifies a rule to associate with a collection.",
"fields": null,
"inputFields": [
{
"name": "column",
"description": "The attribute that the rule focuses on (for example, `title` or `product_type`).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionRuleColumn",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "relation",
"description": "The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`).\n",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionRuleRelation",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "condition",
"description": "The value that the operator is applied to (for example, `Hats`).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionRuleRelation",
"description": "Specifies the relationship between the `column` and the condition.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CONTAINS",
"description": "The attribute contains the condition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENDS_WITH",
"description": "The attribute ends with the condition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EQUALS",
"description": "The attribute is equal to the condition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GREATER_THAN",
"description": "The attribute is greater than the condition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS_NOT_SET",
"description": "The attribute is not set.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS_SET",
"description": "The attribute is set.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LESS_THAN",
"description": "The attribute is less than the condition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_CONTAINS",
"description": "The attribute does not contain the condition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_EQUALS",
"description": "The attribute does not equal the condition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STARTS_WITH",
"description": "The attribute starts with the condition.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionRuleSet",
"description": "The set of rules that are used to determine which products are included in the collection.",
"fields": [
{
"name": "appliedDisjunctively",
"description": "Whether products must match any or all of the rules to be included in the collection.\nIf true, then products must match one or more of the rules to be included in the collection.\nIf false, then products must match all of the rules to be included in the collection.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rules",
"description": "The rules used to assign products to the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionRule",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionRuleSetInput",
"description": "Specifies a rule set for the collection.",
"fields": null,
"inputFields": [
{
"name": "appliedDisjunctively",
"description": "Whether products must match any or all of the rules to be included in the collection.\nIf true, then products must match one or more of the rules to be included in the collection.\nIf false, then products must match all of the rules to be included in the collection.\n",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "rules",
"description": "The rules used to assign products to the collection.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionRuleInput",
"ofType": null
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionSortKeys",
"description": "The set of valid sort keys for the Collection query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "TITLE",
"description": "Sort by the `title` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATED_AT",
"description": "Sort by the `updated_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionSortOrder",
"description": "Specifies the sort order for the products in the collection.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALPHA_ASC",
"description": "Alphabetically, in ascending order (A - Z).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ALPHA_DESC",
"description": "Alphabetically, in descending order (Z - A).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BEST_SELLING",
"description": "By best-selling products.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED",
"description": "By date created, in ascending order (oldest - newest).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED_DESC",
"description": "By date created, in descending order (newest - oldest).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANUAL",
"description": "In the order set manually by the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRICE_ASC",
"description": "By price, in ascending order (lowest - highest).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRICE_DESC",
"description": "By price, in descending order (highest - lowest).",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionUnpublishInput",
"description": "Specifies the collection to unpublish and the sales channels to remove it from.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The collection to create or update publications for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "collectionPublications",
"description": "The channels where the collection is published.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionPublicationInput",
"ofType": null
}
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionUnpublishPayload",
"description": "Return type for `collectionUnpublish` mutation.",
"fields": [
{
"name": "collection",
"description": "The collection that has been unpublished.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "The shop associated with the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionUpdatePayload",
"description": "Return type for `collectionUpdate` mutation.",
"fields": [
{
"name": "collection",
"description": "The updated collection.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "job",
"description": "The asynchronous job updating the products based on the new rule set.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CommentEvent",
"description": "Comment events are generated by staff members of a shop.\nThey are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.\n",
"fields": [
{
"name": "appTitle",
"description": "The name of the app that created the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attachments",
"description": "The attachments associated with the comment event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CommentEventAttachment",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeToApp",
"description": "Whether the event was created by an app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeToUser",
"description": "Whether the event was caused by an admin user.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canDelete",
"description": "Whether the comment event can be deleted. If true, then the comment event can be deleted.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canEdit",
"description": "Whether the comment event can be edited. If true, then the comment event can be edited.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the event was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "criticalAlert",
"description": "Whether the event is critical.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "edited",
"description": "Whether the comment event has been edited. If true, then the comment event has been edited.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "embed",
"description": "The object reference associated with the comment event. For example, a product or discount).",
"args": [],
"type": {
"kind": "UNION",
"name": "CommentEventEmbed",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Human readable text that describes the event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "FormattedString",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rawMessage",
"description": "The raw body of the comment event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subject",
"description": "The parent subject to which the comment event belongs.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "CommentEventSubject",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CommentEventAttachment",
"description": "A file attachment associated to a comment event.",
"fields": [
{
"name": "fileExtension",
"description": "The file extension of the comment event attachment, indicating the file format.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "image",
"description": "The image attached to the comment event.",
"args": [
{
"name": "maxWidth",
"description": "Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "maxHeight",
"description": "Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "crop",
"description": "Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead.",
"type": {
"kind": "ENUM",
"name": "CropRegion",
"ofType": null
},
"defaultValue": null
},
{
"name": "scale",
"description": "Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": "1"
}
],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The filename of the comment event attachment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "The size of the attachment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL of the attachment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "CommentEventEmbed",
"description": "The main embed of a comment event.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrder",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
]
},
{
"kind": "INTERFACE",
"name": "CommentEventSubject",
"description": "The subject line of a comment event.",
"fields": [
{
"name": "hasTimelineComment",
"description": "Whether the timeline subject has a timeline comment. If true, then a timeline comment exists.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrder",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PriceRule",
"ofType": null
}
]
},
{
"kind": "INPUT_OBJECT",
"name": "ContextualPricingContext",
"description": "The context data that determines the pricing of a variant.",
"fields": null,
"inputFields": [
{
"name": "country",
"description": "The country code used to fetch country-specific prices.",
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CountriesInShippingZones",
"description": "The list of all the countries from the combined shipping zones for the shop.",
"fields": [
{
"name": "countryCodes",
"description": "The list of all the countries from all the combined shipping zones.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "includeRestOfWorld",
"description": "Whether 'Rest of World' has been defined in any of the shipping zones.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CountryCode",
"description": "ISO 3166-1 alpha-2 country codes with some differences.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AF",
"description": "Afghanistan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AX",
"description": "Åland Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AL",
"description": "Albania.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DZ",
"description": "Algeria.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AD",
"description": "Andorra.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AO",
"description": "Angola.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AI",
"description": "Anguilla.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AG",
"description": "Antigua & Barbuda.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR",
"description": "Argentina.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AM",
"description": "Armenia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AW",
"description": "Aruba.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AC",
"description": "Ascension Island.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AU",
"description": "Australia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AT",
"description": "Austria.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZ",
"description": "Azerbaijan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BS",
"description": "Bahamas.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BH",
"description": "Bahrain.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BD",
"description": "Bangladesh.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BB",
"description": "Barbados.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BY",
"description": "Belarus.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BE",
"description": "Belgium.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BZ",
"description": "Belize.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BJ",
"description": "Benin.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BM",
"description": "Bermuda.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BT",
"description": "Bhutan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BO",
"description": "Bolivia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BA",
"description": "Bosnia & Herzegovina.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BW",
"description": "Botswana.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BV",
"description": "Bouvet Island.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BR",
"description": "Brazil.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IO",
"description": "British Indian Ocean Territory.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BN",
"description": "Brunei.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BG",
"description": "Bulgaria.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BF",
"description": "Burkina Faso.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BI",
"description": "Burundi.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KH",
"description": "Cambodia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA",
"description": "Canada.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CV",
"description": "Cape Verde.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BQ",
"description": "Caribbean Netherlands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KY",
"description": "Cayman Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CF",
"description": "Central African Republic.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TD",
"description": "Chad.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CL",
"description": "Chile.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CN",
"description": "China.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CX",
"description": "Christmas Island.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CC",
"description": "Cocos (Keeling) Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CO",
"description": "Colombia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KM",
"description": "Comoros.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CG",
"description": "Congo - Brazzaville.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CD",
"description": "Congo - Kinshasa.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CK",
"description": "Cook Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CR",
"description": "Costa Rica.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HR",
"description": "Croatia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CU",
"description": "Cuba.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CW",
"description": "Curaçao.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CY",
"description": "Cyprus.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CZ",
"description": "Czechia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CI",
"description": "Côte d’Ivoire.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DK",
"description": "Denmark.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DJ",
"description": "Djibouti.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DM",
"description": "Dominica.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DO",
"description": "Dominican Republic.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EC",
"description": "Ecuador.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EG",
"description": "Egypt.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SV",
"description": "El Salvador.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GQ",
"description": "Equatorial Guinea.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ER",
"description": "Eritrea.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EE",
"description": "Estonia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SZ",
"description": "Eswatini.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ET",
"description": "Ethiopia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FK",
"description": "Falkland Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FO",
"description": "Faroe Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FJ",
"description": "Fiji.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FI",
"description": "Finland.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR",
"description": "France.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GF",
"description": "French Guiana.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PF",
"description": "French Polynesia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TF",
"description": "French Southern Territories.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GA",
"description": "Gabon.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GM",
"description": "Gambia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GE",
"description": "Georgia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE",
"description": "Germany.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GH",
"description": "Ghana.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GI",
"description": "Gibraltar.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GR",
"description": "Greece.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GL",
"description": "Greenland.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GD",
"description": "Grenada.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GP",
"description": "Guadeloupe.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GT",
"description": "Guatemala.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GG",
"description": "Guernsey.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GN",
"description": "Guinea.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GW",
"description": "Guinea-Bissau.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GY",
"description": "Guyana.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HT",
"description": "Haiti.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HM",
"description": "Heard & McDonald Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VA",
"description": "Vatican City.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HN",
"description": "Honduras.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HK",
"description": "Hong Kong SAR.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HU",
"description": "Hungary.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS",
"description": "Iceland.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IN",
"description": "India.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Indonesia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IR",
"description": "Iran.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IQ",
"description": "Iraq.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IE",
"description": "Ireland.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IM",
"description": "Isle of Man.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IL",
"description": "Israel.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IT",
"description": "Italy.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JM",
"description": "Jamaica.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JP",
"description": "Japan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JE",
"description": "Jersey.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JO",
"description": "Jordan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KZ",
"description": "Kazakhstan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KE",
"description": "Kenya.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KI",
"description": "Kiribati.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KP",
"description": "North Korea.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XK",
"description": "Kosovo.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KW",
"description": "Kuwait.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KG",
"description": "Kyrgyzstan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LA",
"description": "Laos.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LV",
"description": "Latvia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LB",
"description": "Lebanon.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LS",
"description": "Lesotho.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LR",
"description": "Liberia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LY",
"description": "Libya.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LI",
"description": "Liechtenstein.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LT",
"description": "Lithuania.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LU",
"description": "Luxembourg.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MO",
"description": "Macao SAR.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MG",
"description": "Madagascar.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MW",
"description": "Malawi.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MY",
"description": "Malaysia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MV",
"description": "Maldives.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ML",
"description": "Mali.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MT",
"description": "Malta.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MQ",
"description": "Martinique.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MR",
"description": "Mauritania.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MU",
"description": "Mauritius.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YT",
"description": "Mayotte.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MX",
"description": "Mexico.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MD",
"description": "Moldova.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MC",
"description": "Monaco.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MN",
"description": "Mongolia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ME",
"description": "Montenegro.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MS",
"description": "Montserrat.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MA",
"description": "Morocco.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MZ",
"description": "Mozambique.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MM",
"description": "Myanmar (Burma).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NA",
"description": "Namibia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NR",
"description": "Nauru.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NP",
"description": "Nepal.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL",
"description": "Netherlands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AN",
"description": "Netherlands Antilles.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NC",
"description": "New Caledonia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NZ",
"description": "New Zealand.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NI",
"description": "Nicaragua.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NE",
"description": "Niger.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NG",
"description": "Nigeria.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NU",
"description": "Niue.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NF",
"description": "Norfolk Island.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MK",
"description": "North Macedonia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO",
"description": "Norway.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OM",
"description": "Oman.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PK",
"description": "Pakistan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PS",
"description": "Palestinian Territories.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PA",
"description": "Panama.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PG",
"description": "Papua New Guinea.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PY",
"description": "Paraguay.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PE",
"description": "Peru.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PH",
"description": "Philippines.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PN",
"description": "Pitcairn Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PL",
"description": "Poland.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT",
"description": "Portugal.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QA",
"description": "Qatar.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CM",
"description": "Cameroon.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RE",
"description": "Réunion.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RO",
"description": "Romania.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU",
"description": "Russia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RW",
"description": "Rwanda.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BL",
"description": "St. Barthélemy.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SH",
"description": "St. Helena.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KN",
"description": "St. Kitts & Nevis.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LC",
"description": "St. Lucia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MF",
"description": "St. Martin.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PM",
"description": "St. Pierre & Miquelon.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WS",
"description": "Samoa.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SM",
"description": "San Marino.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ST",
"description": "São Tomé & Príncipe.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SA",
"description": "Saudi Arabia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SN",
"description": "Senegal.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RS",
"description": "Serbia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SC",
"description": "Seychelles.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SL",
"description": "Sierra Leone.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SG",
"description": "Singapore.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SX",
"description": "Sint Maarten.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SK",
"description": "Slovakia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SI",
"description": "Slovenia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SB",
"description": "Solomon Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SO",
"description": "Somalia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZA",
"description": "South Africa.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GS",
"description": "South Georgia & South Sandwich Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KR",
"description": "South Korea.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SS",
"description": "South Sudan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES",
"description": "Spain.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LK",
"description": "Sri Lanka.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VC",
"description": "St. Vincent & Grenadines.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD",
"description": "Sudan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR",
"description": "Suriname.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SJ",
"description": "Svalbard & Jan Mayen.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SE",
"description": "Sweden.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CH",
"description": "Switzerland.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SY",
"description": "Syria.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TW",
"description": "Taiwan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TJ",
"description": "Tajikistan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TZ",
"description": "Tanzania.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TH",
"description": "Thailand.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TL",
"description": "Timor-Leste.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TG",
"description": "Togo.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TK",
"description": "Tokelau.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TO",
"description": "Tonga.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TT",
"description": "Trinidad & Tobago.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TA",
"description": "Tristan da Cunha.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TN",
"description": "Tunisia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TR",
"description": "Turkey.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TM",
"description": "Turkmenistan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TC",
"description": "Turks & Caicos Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TV",
"description": "Tuvalu.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UG",
"description": "Uganda.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UA",
"description": "Ukraine.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AE",
"description": "United Arab Emirates.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GB",
"description": "United Kingdom.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "US",
"description": "United States.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UM",
"description": "U.S. Outlying Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UY",
"description": "Uruguay.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ",
"description": "Uzbekistan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VU",
"description": "Vanuatu.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VE",
"description": "Venezuela.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VN",
"description": "Vietnam.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VG",
"description": "British Virgin Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WF",
"description": "Wallis & Futuna.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EH",
"description": "Western Sahara.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YE",
"description": "Yemen.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZM",
"description": "Zambia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZW",
"description": "Zimbabwe.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZZ",
"description": "Unknown Region.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CountryHarmonizedSystemCode",
"description": "The country-specific harmonized system code and ISO country code for an inventory item.\n",
"fields": [
{
"name": "countryCode",
"description": "The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "harmonizedSystemCode",
"description": "The country-specific harmonized system code. These are usually longer than 6 digits.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CountryHarmonizedSystemCodeConnection",
"description": "An auto-generated type for paginating through multiple CountryHarmonizedSystemCodes.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryHarmonizedSystemCodeEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CountryHarmonizedSystemCodeEdge",
"description": "An auto-generated type which holds one CountryHarmonizedSystemCode and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CountryHarmonizedSystemCodeEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryHarmonizedSystemCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CountryHarmonizedSystemCodeInput",
"description": "The fields required to specify a harmonized system code.\n",
"fields": null,
"inputFields": [
{
"name": "harmonizedSystemCode",
"description": "Country specific harmonized system code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "countryCode",
"description": "The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CreateMediaInput",
"description": "Specifies the input fields required to create a media object.",
"fields": null,
"inputFields": [
{
"name": "originalSource",
"description": "The original source of the media object. May be an external URL or signed upload URL.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "alt",
"description": "The alt text associated to the media.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "mediaContentType",
"description": "The media content type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MediaContentType",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CropRegion",
"description": "The part of the image that should remain after cropping.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CENTER",
"description": "Keep the center of the image.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOP",
"description": "Keep the top of the image.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BOTTOM",
"description": "Keep the bottom of the image.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LEFT",
"description": "Keep the left of the image.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RIGHT",
"description": "Keep the right of the image.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CurrencyCode",
"description": "The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes,\nand non-standard codes.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "USD",
"description": "United States Dollars (USD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EUR",
"description": "Euro (EUR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GBP",
"description": "United Kingdom Pounds (GBP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CAD",
"description": "Canadian Dollars (CAD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AFN",
"description": "Afghan Afghani (AFN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ALL",
"description": "Albanian Lek (ALL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DZD",
"description": "Algerian Dinar (DZD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AOA",
"description": "Angolan Kwanza (AOA).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ARS",
"description": "Argentine Pesos (ARS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AMD",
"description": "Armenian Dram (AMD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AWG",
"description": "Aruban Florin (AWG).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUD",
"description": "Australian Dollars (AUD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BBD",
"description": "Barbadian Dollar (BBD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZN",
"description": "Azerbaijani Manat (AZN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BDT",
"description": "Bangladesh Taka (BDT).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BSD",
"description": "Bahamian Dollar (BSD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BHD",
"description": "Bahraini Dinar (BHD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BIF",
"description": "Burundian Franc (BIF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BZD",
"description": "Belize Dollar (BZD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BMD",
"description": "Bermudian Dollar (BMD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BTN",
"description": "Bhutanese Ngultrum (BTN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BAM",
"description": "Bosnia and Herzegovina Convertible Mark (BAM).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BRL",
"description": "Brazilian Real (BRL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BOB",
"description": "Bolivian Boliviano (BOB).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BWP",
"description": "Botswana Pula (BWP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BND",
"description": "Brunei Dollar (BND).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BGN",
"description": "Bulgarian Lev (BGN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MMK",
"description": "Burmese Kyat (MMK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KHR",
"description": "Cambodian Riel.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CVE",
"description": "Cape Verdean escudo (CVE).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KYD",
"description": "Cayman Dollars (KYD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XAF",
"description": "Central African CFA Franc (XAF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CLP",
"description": "Chilean Peso (CLP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CNY",
"description": "Chinese Yuan Renminbi (CNY).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COP",
"description": "Colombian Peso (COP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KMF",
"description": "Comorian Franc (KMF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CDF",
"description": "Congolese franc (CDF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CRC",
"description": "Costa Rican Colones (CRC).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HRK",
"description": "Croatian Kuna (HRK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CZK",
"description": "Czech Koruny (CZK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DKK",
"description": "Danish Kroner (DKK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DOP",
"description": "Dominican Peso (DOP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XCD",
"description": "East Caribbean Dollar (XCD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EGP",
"description": "Egyptian Pound (EGP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ETB",
"description": "Ethiopian Birr (ETB).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XPF",
"description": "CFP Franc (XPF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FJD",
"description": "Fijian Dollars (FJD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GMD",
"description": "Gambian Dalasi (GMD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GHS",
"description": "Ghanaian Cedi (GHS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GTQ",
"description": "Guatemalan Quetzal (GTQ).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GYD",
"description": "Guyanese Dollar (GYD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GEL",
"description": "Georgian Lari (GEL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HTG",
"description": "Haitian Gourde (HTG).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HNL",
"description": "Honduran Lempira (HNL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HKD",
"description": "Hong Kong Dollars (HKD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HUF",
"description": "Hungarian Forint (HUF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ISK",
"description": "Icelandic Kronur (ISK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INR",
"description": "Indian Rupees (INR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IDR",
"description": "Indonesian Rupiah (IDR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ILS",
"description": "Israeli New Shekel (NIS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IQD",
"description": "Iraqi Dinar (IQD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JMD",
"description": "Jamaican Dollars (JMD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JPY",
"description": "Japanese Yen (JPY).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JEP",
"description": "Jersey Pound.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JOD",
"description": "Jordanian Dinar (JOD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KZT",
"description": "Kazakhstani Tenge (KZT).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KES",
"description": "Kenyan Shilling (KES).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KWD",
"description": "Kuwaiti Dinar (KWD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KGS",
"description": "Kyrgyzstani Som (KGS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAK",
"description": "Laotian Kip (LAK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LVL",
"description": "Latvian Lati (LVL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LBP",
"description": "Lebanese Pounds (LBP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LSL",
"description": "Lesotho Loti (LSL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LRD",
"description": "Liberian Dollar (LRD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LTL",
"description": "Lithuanian Litai (LTL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MGA",
"description": "Malagasy Ariary (MGA).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MKD",
"description": "Macedonia Denar (MKD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MOP",
"description": "Macanese Pataca (MOP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MWK",
"description": "Malawian Kwacha (MWK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MVR",
"description": "Maldivian Rufiyaa (MVR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MXN",
"description": "Mexican Pesos (MXN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MYR",
"description": "Malaysian Ringgits (MYR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MUR",
"description": "Mauritian Rupee (MUR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MDL",
"description": "Moldovan Leu (MDL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAD",
"description": "Moroccan Dirham.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MNT",
"description": "Mongolian Tugrik.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MZN",
"description": "Mozambican Metical.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAD",
"description": "Namibian Dollar.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NPR",
"description": "Nepalese Rupee (NPR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ANG",
"description": "Netherlands Antillean Guilder.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NZD",
"description": "New Zealand Dollars (NZD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NIO",
"description": "Nicaraguan Córdoba (NIO).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NGN",
"description": "Nigerian Naira (NGN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOK",
"description": "Norwegian Kroner (NOK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OMR",
"description": "Omani Rial (OMR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAB",
"description": "Panamian Balboa (PAB).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PKR",
"description": "Pakistani Rupee (PKR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PGK",
"description": "Papua New Guinean Kina (PGK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PYG",
"description": "Paraguayan Guarani (PYG).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PEN",
"description": "Peruvian Nuevo Sol (PEN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PHP",
"description": "Philippine Peso (PHP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PLN",
"description": "Polish Zlotych (PLN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QAR",
"description": "Qatari Rial (QAR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RON",
"description": "Romanian Lei (RON).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RUB",
"description": "Russian Rubles (RUB).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RWF",
"description": "Rwandan Franc (RWF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WST",
"description": "Samoan Tala (WST).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAR",
"description": "Saudi Riyal (SAR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STD",
"description": "Sao Tome And Principe Dobra (STD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RSD",
"description": "Serbian dinar (RSD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SCR",
"description": "Seychellois Rupee (SCR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SGD",
"description": "Singapore Dollars (SGD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SDG",
"description": "Sudanese Pound (SDG).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SYP",
"description": "Syrian Pound (SYP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZAR",
"description": "South African Rand (ZAR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KRW",
"description": "South Korean Won (KRW).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SSP",
"description": "South Sudanese Pound (SSP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SBD",
"description": "Solomon Islands Dollar (SBD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LKR",
"description": "Sri Lankan Rupees (LKR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SRD",
"description": "Surinamese Dollar (SRD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SZL",
"description": "Swazi Lilangeni (SZL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SEK",
"description": "Swedish Kronor (SEK).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHF",
"description": "Swiss Francs (CHF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TWD",
"description": "Taiwan Dollars (TWD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "THB",
"description": "Thai baht (THB).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TZS",
"description": "Tanzanian Shilling (TZS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TTD",
"description": "Trinidad and Tobago Dollars (TTD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TND",
"description": "Tunisian Dinar (TND).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRY",
"description": "Turkish Lira (TRY).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TMT",
"description": "Turkmenistani Manat (TMT).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UGX",
"description": "Ugandan Shilling (UGX).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UAH",
"description": "Ukrainian Hryvnia (UAH).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AED",
"description": "United Arab Emirates Dirham (AED).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UYU",
"description": "Uruguayan Pesos (UYU).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZS",
"description": "Uzbekistan som (UZS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VUV",
"description": "Vanuatu Vatu (VUV).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VND",
"description": "Vietnamese đồng (VND).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XOF",
"description": "West African CFA franc (XOF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YER",
"description": "Yemeni Rial (YER).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZMW",
"description": "Zambian Kwacha (ZMW).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BYN",
"description": "Belarusian Ruble (BYN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BYR",
"description": "Belarusian Ruble (BYR).",
"isDeprecated": true,
"deprecationReason": "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead."
},
{
"name": "DJF",
"description": "Djiboutian Franc (DJF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ERN",
"description": "Eritrean Nakfa (ERN).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FKP",
"description": "Falkland Islands Pounds (FKP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIP",
"description": "Gibraltar Pounds (GIP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GNF",
"description": "Guinean Franc (GNF).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IRR",
"description": "Iranian Rial (IRR).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KID",
"description": "Kiribati Dollar (KID).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LYD",
"description": "Libyan Dinar (LYD).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MRU",
"description": "Mauritanian Ouguiya (MRU).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SLL",
"description": "Sierra Leonean Leone (SLL).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHP",
"description": "Saint Helena Pounds (SHP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SOS",
"description": "Somali Shilling (SOS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TJS",
"description": "Tajikistani Somoni (TJS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOP",
"description": "Tongan Pa'anga (TOP).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VEF",
"description": "Venezuelan Bolivares (VEF).",
"isDeprecated": true,
"deprecationReason": "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead."
},
{
"name": "VES",
"description": "Venezuelan Bolivares (VES).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XXX",
"description": "Unrecognized currency.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CurrencyFormats",
"description": "Currency formats configured for the merchant. These formats are available to use within Liquid.",
"fields": [
{
"name": "moneyFormat",
"description": "Money without currency in HTML.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "FormattedString",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moneyInEmailsFormat",
"description": "Money without currency in emails.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moneyWithCurrencyFormat",
"description": "Money with currency in HTML.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "FormattedString",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moneyWithCurrencyInEmailsFormat",
"description": "Money with currency in emails.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CurrencySetting",
"description": "A setting for a presentment currency.",
"fields": [
{
"name": "currencyCode",
"description": "The currency's ISO code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CurrencyCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currencyName",
"description": "The full name of the currency.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "enabled",
"description": "Whether the currency is enabled or not. An enabled currency setting is visible to buyers and allows orders to be generated with that currency as presentment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rateUpdatedAt",
"description": "The date and time when the active exchange rate for the currency was last modified. It can be the automatic rate's creation date, or the manual rate's last updated at date if active.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CurrencySettingConnection",
"description": "An auto-generated type for paginating through multiple CurrencySettings.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CurrencySettingEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CurrencySettingEdge",
"description": "An auto-generated type which holds one CurrencySetting and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CurrencySettingEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CurrencySetting",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Customer",
"description": "Represents information about a customer of the shop, such as the customer's contact details, their order\nhistory, and whether they've agreed to receive marketing material by email.\n\n**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.\n",
"fields": [
{
"name": "acceptsMarketing",
"description": "Whether the customer has agreed to receive marketing material.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "acceptsMarketingUpdatedAt",
"description": "The date and time when the customer consented or objected to receiving marketing material by email.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addresses",
"description": "A list of addresses associated with the customer.",
"args": [
{
"name": "first",
"description": "Truncate the array result to this size.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MailingAddress",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "averageOrderAmount",
"description": "The average amount that the customer spent per order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `averageOrderAmountV2` instead"
},
{
"name": "averageOrderAmountV2",
"description": "The average amount that the customer spent per order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canDelete",
"description": "Whether the merchant can delete the customer from their store.\n\nA customer can be deleted from a store only if they have not yet made an order. After a customer makes an\norder, they can't be deleted from a store.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the customer was added to the store.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultAddress",
"description": "The default address associated with the customer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MailingAddress",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayName",
"description": "The full name of the customer, based on the values for first_name and last_name. If the first_name and\nlast_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The customer's email address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "A list of events associated with the customer.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "EventSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "The customer's first name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasNote",
"description": "Whether the customer has a note associated with them.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasTimelineComment",
"description": "Whether the merchant has added timeline comments about the customer on the customer's page.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "image",
"description": "The image associated with the customer.",
"args": [
{
"name": "size",
"description": "Image width and height (1 - 2048 pixels) This argument is deprecated: Use `maxWidth` or `maxHeight` on `Image.transformedSrc` instead.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "The customer's last name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastOrder",
"description": "The customer's last order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "legacyResourceId",
"description": "The ID of the corresponding resource in the REST Admin API.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lifetimeDuration",
"description": "The amount of time since the customer was first added to the store.\n\nExample: 'about 12 years'.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locale",
"description": "The customer's locale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingOptInLevel",
"description": "The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the\ncustomer gave when they consented to receive marketing material by email.\n\nIf the customer does not accept email marketing, then this property is `null`.\n",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerMarketingOptInLevel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "Returns a metafield by namespace and key that belongs to the resource.",
"args": [
{
"name": "namespace",
"description": "The namespace for the metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "The key for the metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Metafield",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafieldDefinitions",
"description": "List of metafield definitions.",
"args": [
{
"name": "namespace",
"description": "Filter metafield definitions by namespace.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "pinnedStatus",
"description": "Filter by the definition's pinned status.",
"type": {
"kind": "ENUM",
"name": "MetafieldDefinitionPinnedStatus",
"ofType": null
},
"defaultValue": "ANY"
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "MetafieldDefinitionSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetafieldDefinitionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "List of metafields that belong to the resource.",
"args": [
{
"name": "namespace",
"description": "The metafield namespace to filter by.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetafieldConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "multipassIdentifier",
"description": "A unique identifier for the customer that's used with Multipass login.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "A note about the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orders",
"description": "A list of the customer's orders.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "OrderSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `cart_token`\n - `channel`\n - `channel_id`\n - `chargeback_status`\n - `checkout_token`\n - `created_at`\n - `credit_card_last4`\n - `customer_id`\n - `delivery_method`\n - `discount_code`\n - `earliest_fulfill_by`\n - `email`\n - `financial_status`\n - `fraud_protection_level`\n - `fulfillment_location_id`\n - `fulfillment_status`\n - `gateway`\n - `location_id`\n - `name`\n - `payment_provider_id`\n - `processed_at`\n - `reference_location_id`\n - `return_status`\n - `risk_level`\n - `sales_channel`\n - `source_identifier`\n - `source_name`\n - `status`\n - `tag`\n - `tag_not`\n - `test`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ordersCount",
"description": "The number of orders that the customer has made at the store in their lifetime.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentMethods",
"description": "A list of the customer's payment methods.",
"args": [
{
"name": "showRevoked",
"description": "Whether to show the customer's revoked payment method.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethodConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "phone",
"description": "The customer's phone number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "Returns a private metafield by namespace and key that belongs to the resource.",
"args": [
{
"name": "namespace",
"description": "The namespace for the private metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "The key for the private metafield.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "PrivateMetafield",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "List of private metafields that belong to the resource.",
"args": [
{
"name": "namespace",
"description": "Filter the private metafields by namespace.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PrivateMetafieldConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productSubscriberStatus",
"description": "Possible subscriber states of a customer defined by their subscription contracts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CustomerProductSubscriberStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "smsMarketingConsent",
"description": "The current SMS marketing state for the customer's phone number.\n\nIf the customer does not have a phone number, then this property is `null`.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerSmsMarketingConsentState",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "state",
"description": "The state of the customer's account with the shop.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CustomerState",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subscriptionContracts",
"description": "A list of the customer's subscription contracts.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SubscriptionContractConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tags",
"description": "A comma separated list of tags that have been added to the customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxExempt",
"description": "Whether the customer is exempt from being charged taxes on their orders.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxExemptions",
"description": "The list of tax exemptions applied to the customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxExemption",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalSpent",
"description": "The total amount that the customer has spent on orders in their lifetime.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalSpentV2",
"description": "The total amount that the customer has spent on orders in their lifetime.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The date and time when the customer was last updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "validEmailAddress",
"description": "Whether the email address is formatted correctly. This does not\nguarantee that the email address actually exists.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "verifiedEmail",
"description": "Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "CommentEventSubject",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasEvents",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasMetafieldDefinitions",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasMetafields",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerAddTaxExemptionsPayload",
"description": "Return type for `customerAddTaxExemptions` mutation.",
"fields": [
{
"name": "customer",
"description": "The updated customer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerConnection",
"description": "An auto-generated type for paginating through multiple Customers.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerConsentCollectedFrom",
"description": "The source that collected the customer's consent to receive marketing materials.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SHOPIFY",
"description": "The customer consent was collected by Shopify.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OTHER",
"description": "The customer consent was collected outside of Shopify.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerCreatePayload",
"description": "Return type for `customerCreate` mutation.",
"fields": [
{
"name": "customer",
"description": "The created customer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerCreditCard",
"description": "Represents a card instrument for customer payment method.",
"fields": [
{
"name": "billingAddress",
"description": "The billing address of the card.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerCreditCardBillingAddress",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "brand",
"description": "The brand of the card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiresSoon",
"description": "Whether the card is about to expire.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryMonth",
"description": "The expiry month of the card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryYear",
"description": "The expiry year of the card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstDigits",
"description": "The card's BIN number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isRevocable",
"description": "The payment method can be revoked if there are no active subscription contracts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastDigits",
"description": "The last 4 digits of the card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maskedNumber",
"description": "The masked card number with only the last 4 digits displayed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the card holder.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "source",
"description": "The source of the card if coming from a wallet such as Apple Pay.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "virtualLastDigits",
"description": "The last 4 digits of the Device Account Number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerCreditCardBillingAddress",
"description": "The billing address of a credit card payment instrument.",
"fields": [
{
"name": "address1",
"description": "The first line of the address. Typically the street address or PO Box number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "city",
"description": "The name of the city, district, village, or town.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "The name of the country.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "The two-letter code for the country of the address.\nFor example, US.\n",
"args": [],
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "province",
"description": "The region of the address, such as the province, state, or district.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "provinceCode",
"description": "The two-letter code for the region.\nFor example, ON.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "zip",
"description": "The zip or postal code of the address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerDeleteInput",
"description": "Specifies the customer to delete.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The ID of the customer to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerDeletePayload",
"description": "Return type for `customerDelete` mutation.",
"fields": [
{
"name": "deletedCustomerId",
"description": "The ID of the deleted customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "The shop of the deleted customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerEdge",
"description": "An auto-generated type which holds one Customer and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CustomerEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerGenerateAccountActivationUrlPayload",
"description": "Return type for `customerGenerateAccountActivationUrl` mutation.",
"fields": [
{
"name": "accountActivationUrl",
"description": "The generated account activation URL.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerInput",
"description": "Provides the fields and values to use when creating or updating a customer.",
"fields": null,
"inputFields": [
{
"name": "acceptsMarketing",
"description": "Whether the customer has consented to receive marketing material via email.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "acceptsMarketingUpdatedAt",
"description": "The date and time when the customer consented or objected to receiving marketing material by email.\n",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "addresses",
"description": "The addresses for a customer.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MailingAddressInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "email",
"description": "The unique email address of the customer.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "firstName",
"description": "The customer's first name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "id",
"description": "The ID of the customer to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "lastName",
"description": "The customer's last name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "locale",
"description": "The customer's locale.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "marketingOptInLevel",
"description": "The marketing subscription opt-in level used when the customer consented to receiving marketing material by email.\n",
"type": {
"kind": "ENUM",
"name": "CustomerMarketingOptInLevel",
"ofType": null
},
"defaultValue": null
},
{
"name": "metafields",
"description": "Additional metafields to associate to the customer.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetafieldInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "note",
"description": "A note about the customer.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "phone",
"description": "The unique phone number for the customer.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "privateMetafields",
"description": "The private metafields to associate with the customer.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PrivateMetafieldInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "tags",
"description": "A list of tags to associate with the customer. Can be an array or a comma-separated list. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`\n\nUpdating `tags` overwrites any existing tags that were previously added to the customer. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "smsMarketingConsent",
"description": "The marketing consent information when the customer consented to receiving marketing\n material by SMS. The `phone` field is required when creating a customer with SMS\n marketing consent information.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CustomerSmsMarketingConsentInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "taxExempt",
"description": "Whether the customer is exempt from paying taxes on their order.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "taxExemptions",
"description": "The list of tax exemptions to apply to the customer.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxExemption",
"ofType": null
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerJourney",
"description": "Represents a customer's visiting activities on a shop's online store.",
"fields": [
{
"name": "customerOrderIndex",
"description": "The position of the current order within the customer's order history.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "daysToConversion",
"description": "The amount of days between first session and order creation date. First session represents first session since the last order, or first session within the 30 day attribution window, if more than 30 days has passed since the last order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstVisit",
"description": "The customer's first session going into the shop.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerVisit",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastVisit",
"description": "The last session before an order is made.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerVisit",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moments",
"description": "Events preceding a customer order, such as shop sessions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "CustomerMoment",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerJourneySummary",
"description": "Represents a customer's visiting activities on a shop's online store.",
"fields": [
{
"name": "customerOrderIndex",
"description": "The position of the current order within the customer's order history. Test orders aren't included.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "daysToConversion",
"description": "The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstVisit",
"description": "The customer's first session going into the shop.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerVisit",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastVisit",
"description": "The last session before an order is made.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerVisit",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moments",
"description": "The events preceding a customer's order, such as shop sessions.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "OBJECT",
"name": "CustomerMomentConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "momentsCount",
"description": "The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ready",
"description": "Whether or not the attributed sessions for the order have been created yet.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerMarketingOptInLevel",
"description": "The possible values for the marketing subscription opt in level enabled at the time the customer consented to receive marketing information.\n\nThe levels are defined by [the M3AAWG best practices guideline\n document](https://www.m3aawg.org/sites/maawg/files/news/M3AAWG_Senders_BCP_Ver3-2015-02.pdf).\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SINGLE_OPT_IN",
"description": "After providing their information, the customer receives marketing information without any\nintermediate steps.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONFIRMED_OPT_IN",
"description": "After providing their information, the customer receives a confirmation and is required to\nperform a intermediate step before receiving marketing information.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNKNOWN",
"description": "The customer receives marketing information but how they were opted in is unknown.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "CustomerMoment",
"description": "Represents a session preceding an order, often used for building a timeline of events leading to an order.",
"fields": [
{
"name": "occurredAt",
"description": "The date and time when the customer's session occurred.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "CustomerVisit",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "CustomerMomentConnection",
"description": "An auto-generated type for paginating through multiple CustomerMoments.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerMomentEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerMomentEdge",
"description": "An auto-generated type which holds one CustomerMoment and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CustomerMomentEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "CustomerMoment",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "CustomerPaymentInstrument",
"description": "All possible instruments for CustomerPaymentMethods.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "CustomerCreditCard",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CustomerPaypalBillingAgreement",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CustomerShopPayAgreement",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "CustomerPaymentInstrumentBillingAddress",
"description": "The billing address of a payment instrument.",
"fields": [
{
"name": "address1",
"description": "The first line of the address. Typically the street address or PO Box number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "city",
"description": "The name of the city, district, village, or town.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "The name of the country.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "The two-letter code for the country of the address.\nFor example, US.\n",
"args": [],
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the buyer of the address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "province",
"description": "The region of the address, such as the province, state, or district.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "provinceCode",
"description": "The two-letter code for the region.\nFor example, ON.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "zip",
"description": "The zip or postal code of the address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"description": "A customer's payment method.",
"fields": [
{
"name": "customer",
"description": "The customer to whom the payment method belongs.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of this payment method.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "instrument",
"description": "The instrument for this payment method.",
"args": [],
"type": {
"kind": "UNION",
"name": "CustomerPaymentInstrument",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "revokedAt",
"description": "The time that the payment method was revoked.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "revokedReason",
"description": "The revocation reason for this payment method.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerPaymentMethodRevocationReason",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subscriptionContracts",
"description": "List Subscription Contracts.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SubscriptionContractConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodConnection",
"description": "An auto-generated type for paginating through multiple CustomerPaymentMethods.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethodEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodCreditCardCreatePayload",
"description": "Return type for `customerPaymentMethodCreditCardCreate` mutation.",
"fields": [
{
"name": "customerPaymentMethod",
"description": "The customer payment method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodCreditCardUpdatePayload",
"description": "Return type for `customerPaymentMethodCreditCardUpdate` mutation.",
"fields": [
{
"name": "customerPaymentMethod",
"description": "The customer payment method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodEdge",
"description": "An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of CustomerPaymentMethodEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodGetUpdateUrlPayload",
"description": "Return type for `customerPaymentMethodGetUpdateUrl` mutation.",
"fields": [
{
"name": "updatePaymentMethodUrl",
"description": "The URL to redirect the customer to update the payment method.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethodGetUpdateUrlUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodGetUpdateUrlUserError",
"description": "An error that occurs during the execution of `CustomerPaymentMethodGetUpdateUrl`.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerPaymentMethodGetUpdateUrlUserErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerPaymentMethodGetUpdateUrlUserErrorCode",
"description": "Possible error codes that can be returned by `CustomerPaymentMethodGetUpdateUrlUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PAYMENT_METHOD_DOES_NOT_EXIST",
"description": "Payment method doesn't exist.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_INSTRUMENT",
"description": "Invalid payment instrument.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOO_MANY_REQUESTS",
"description": "Too many requests.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_DOES_NOT_EXIST",
"description": "Customer doesn't exist.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodPaypalBillingAgreementCreatePayload",
"description": "Return type for `customerPaymentMethodPaypalBillingAgreementCreate` mutation.",
"fields": [
{
"name": "customerPaymentMethod",
"description": "The customer payment method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethodUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodPaypalBillingAgreementUpdatePayload",
"description": "Return type for `customerPaymentMethodPaypalBillingAgreementUpdate` mutation.",
"fields": [
{
"name": "customerPaymentMethod",
"description": "The customer payment method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethodUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodRemoteCreatePayload",
"description": "Return type for `customerPaymentMethodRemoteCreate` mutation.",
"fields": [
{
"name": "customerPaymentMethod",
"description": "The customer payment method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethodRemoteUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodRemoteCreditCardCreatePayload",
"description": "Return type for `customerPaymentMethodRemoteCreditCardCreate` mutation.",
"fields": [
{
"name": "customerPaymentMethod",
"description": "The customer payment method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerPaymentMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerPaymentMethodUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerPaymentMethodRemoteInput",
"description": "Input for a remote gateway payment method, only one remote reference permitted.\n",
"fields": null,
"inputFields": [
{
"name": "stripePaymentMethod",
"description": "Input containing the fields for a remote stripe payment method.\n",
"type": {
"kind": "INPUT_OBJECT",
"name": "RemoteStripePaymentMethodInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "authorizeNetCustomerPaymentProfile",
"description": "Input containing the fields for a remote authorize net customer profile.\n",
"type": {
"kind": "INPUT_OBJECT",
"name": "RemoteAuthorizeNetCustomerPaymentProfileInput",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodRemoteUserError",
"description": "Represents an error in the input of a mutation.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerPaymentMethodRemoteUserErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerPaymentMethodRemoteUserErrorCode",
"description": "Possible error codes that can be returned by `CustomerPaymentMethodRemoteUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INVALID",
"description": "The input value is invalid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRESENT",
"description": "The input value needs to be blank.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAKEN",
"description": "The input value is already taken.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXACTLY_ONE_REMOTE_REFERENCE_REQUIRED",
"description": "Exactly one remote reference is required.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTHORIZE_NET_NOT_ENABLED_FOR_SUBSCRIPTIONS",
"description": "Authorize.net is not enabled for subscriptions.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerPaymentMethodRevocationReason",
"description": "The revocation reason types for a customer payment method.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AUTHORIZE_NET_GATEWAY_NOT_ENABLED",
"description": "The Authorize.net payment gateway is not enabled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD",
"description": "Authorize.net did not return any payment methods. Make sure that the correct Authorize.net account is linked.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FAILED_TO_UPDATE_CREDIT_CARD",
"description": "The credit card failed to update.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANUALLY_REVOKED",
"description": "The payment method was manually revoked.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STRIPE_API_AUTHENTICATION_ERROR",
"description": "Failed to contact the Stripe API.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STRIPE_API_INVALID_REQUEST_ERROR",
"description": "Invalid request. Failed to retrieve payment method from Stripe.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STRIPE_GATEWAY_NOT_ENABLED",
"description": "The Stripe payment gateway is not enabled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STRIPE_RETURNED_NO_PAYMENT_METHOD",
"description": "Stripe did not return any payment methods. Make sure that the correct Stripe account is linked.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STRIPE_PAYMENT_METHOD_NOT_CARD",
"description": "The Stripe payment method type should be card.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodRevokePayload",
"description": "Return type for `customerPaymentMethodRevoke` mutation.",
"fields": [
{
"name": "revokedCustomerPaymentMethodId",
"description": "The ID of the revoked customer payment method.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodSendUpdateEmailPayload",
"description": "Return type for `customerPaymentMethodSendUpdateEmail` mutation.",
"fields": [
{
"name": "customer",
"description": "The customer to whom an update payment method email was sent.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaymentMethodUserError",
"description": "Represents an error in the input of a mutation.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerPaymentMethodUserErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerPaymentMethodUserErrorCode",
"description": "Possible error codes that can be returned by `CustomerPaymentMethodUserError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INVALID",
"description": "The input value is invalid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRESENT",
"description": "The input value needs to be blank.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAKEN",
"description": "The input value is already taken.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerPaypalBillingAgreement",
"description": "Represents a PayPal instrument for customer payment method.",
"fields": [
{
"name": "billingAddress",
"description": "The billing address of this payment method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerPaymentInstrumentBillingAddress",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inactive",
"description": "Whether the PayPal billing agreement is inactive.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isRevocable",
"description": "Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paypalAccountEmail",
"description": "The customers's PayPal account email address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerProductSubscriberStatus",
"description": "The possible product subscription states for a customer, as defined by the customer's subscription contracts.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACTIVE",
"description": "The customer has at least one active subscription contract.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCELLED",
"description": "The customer's last subscription contract was cancelled and there are no other active or paused\nsubscription contracts.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": "The customer's last subscription contract expired and there are no other active or paused\nsubscription contracts.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FAILED",
"description": "The customer's last subscription contract failed and there are no other active or paused\nsubscription contracts.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NEVER_SUBSCRIBED",
"description": "The customer has never had a subscription contract.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAUSED",
"description": "The customer has at least one paused subscription contract and there are no other active\nsubscription contracts.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerRemoveTaxExemptionsPayload",
"description": "Return type for `customerRemoveTaxExemptions` mutation.",
"fields": [
{
"name": "customer",
"description": "The updated customer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerReplaceTaxExemptionsPayload",
"description": "Return type for `customerReplaceTaxExemptions` mutation.",
"fields": [
{
"name": "customer",
"description": "The updated customer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerSavedSearchSortKeys",
"description": "The set of valid sort keys for the CustomerSavedSearch query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort by the `name` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerShopPayAgreement",
"description": "Represents a Shop Pay card instrument for customer payment method.",
"fields": [
{
"name": "expiresSoon",
"description": "Whether the card is about to expire.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryMonth",
"description": "The expiry month of the card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryYear",
"description": "The expiry year of the card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inactive",
"description": "Whether the Shop Pay billing agreement is inactive.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isRevocable",
"description": "The payment method can be revoked if there are no active subscription contracts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastDigits",
"description": "The last 4 digits of the card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maskedNumber",
"description": "The masked card number with only the last 4 digits displayed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the card holder.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerSmsMarketingConsentError",
"description": "An error that occurs during execution of an SMS marketing consent mutation.",
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerSmsMarketingConsentErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The path to the input field that caused the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DisplayableError",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerSmsMarketingConsentErrorCode",
"description": "Possible error codes that can be returned by `CustomerSmsMarketingConsentError`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INVALID",
"description": "The input value is invalid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCLUSION",
"description": "The input value isn't included in the list.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INTERNAL_ERROR",
"description": "Unexpected internal error happened.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_ARGUMENT",
"description": "Missing a required argument.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerSmsMarketingConsentInput",
"description": "The marketing consent information when the customer consented to\n receiving marketing material by SMS.",
"fields": null,
"inputFields": [
{
"name": "marketingOptInLevel",
"description": "The marketing subscription opt in level set when the customer consented to receive marketing information.\n",
"type": {
"kind": "ENUM",
"name": "CustomerMarketingOptInLevel",
"ofType": null
},
"defaultValue": null
},
{
"name": "marketingState",
"description": "The current SMS marketing state for the customer.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CustomerSmsMarketingState",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "consentUpdatedAt",
"description": "The date and time when the customer consented to receive marketing material by SMS.\nIf no date is provided, then the date and time when the consent information was sent is used.\n",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerSmsMarketingConsentState",
"description": "The record of when a customer consented to receive marketing material by SMS.\n\nThe customer's consent state reflects the record with the most recent date when consent was updated.\n",
"fields": [
{
"name": "consentCollectedFrom",
"description": "The source from which the SMS marketing information for the customer was collected.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerConsentCollectedFrom",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "consentUpdatedAt",
"description": "The date and time when the customer consented to receive marketing material by SMS.\nIf no date is provided, then the date and time when the consent information was sent is used.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingOptInLevel",
"description": "The marketing subscription opt in level set when the customer consented to receive marketing information.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CustomerMarketingOptInLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingState",
"description": "The current SMS marketing state for the customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CustomerSmsMarketingState",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerSmsMarketingConsentUpdateInput",
"description": "The SMS marketing consent information to update for a given customer ID.\n",
"fields": null,
"inputFields": [
{
"name": "customerId",
"description": "The ID of the customer to update the SMS marketing consent information for. The customer must have a unique phone number associated to the record. If not, add the phone number using the `customerUpdate` mutation first.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "smsMarketingConsent",
"description": "The marketing consent information when the customer consented to receiving marketing material by SMS.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CustomerSmsMarketingConsentInput",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerSmsMarketingConsentUpdatePayload",
"description": "Return type for `customerSmsMarketingConsentUpdate` mutation.",
"fields": [
{
"name": "customer",
"description": "The updated customer.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerSmsMarketingConsentError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerSmsMarketingState",
"description": "The valid SMS marketing states for a customer’s phone number.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NOT_SUBSCRIBED",
"description": "The customer hasn't subscribed to SMS marketing.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PENDING",
"description": "The customer is in the process of subscribing to SMS marketing.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SUBSCRIBED",
"description": "The customer is subscribed to SMS marketing.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNSUBSCRIBED",
"description": "The customer isn't currently subscribed to SMS marketing but was previously subscribed.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REDACTED",
"description": "The customer's personal data is erased. This value is internally-set and read-only.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerSortKeys",
"description": "The set of valid sort keys for the Customer query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort by the `name` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LOCATION",
"description": "Sort by the `location` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDERS_COUNT",
"description": "Sort by the `orders_count` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_ORDER_DATE",
"description": "Sort by the `last_order_date` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOTAL_SPENT",
"description": "Sort by the `total_spent` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATED_AT",
"description": "Sort by the `updated_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerState",
"description": "The valid values for the state of a customer's account with a shop.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DECLINED",
"description": "The customer declined the email invite to create an account.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DISABLED",
"description": "The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENABLED",
"description": "The customer has created an account.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVITED",
"description": "The customer has received an email invite to create an account.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerUpdateDefaultAddressPayload",
"description": "Return type for `customerUpdateDefaultAddress` mutation.",
"fields": [
{
"name": "customer",
"description": "The customer whose address was updated.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerUpdatePayload",
"description": "Return type for `customerUpdate` mutation.",
"fields": [
{
"name": "customer",
"description": "The updated customer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerVisit",
"description": "Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session.",
"fields": [
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "landingPage",
"description": "URL of the first page the customer landed on for the session.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "landingPageHtml",
"description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "HTML",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingEvent",
"description": "Represent actions taken by an app, on behalf of a merchant,\nto market Shopify resources such as products, collections, and discounts.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MarketingEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "occurredAt",
"description": "The date and time when the customer's session occurred.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "referralCode",
"description": "Marketing referral code from the link that the customer clicked to visit the store.\nSupports the following URL attributes: _ref_, _source_, or _r_.\nFor example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "referralInfoHtml",
"description": "Referral information with URLs linked in HTML.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "FormattedString",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "referrerUrl",
"description": "Webpage where the customer clicked a link that sent them to the online store.\nFor example, _https://randomblog.com/page1_ or _android-app://com.google.android.gm_.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "source",
"description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct,\na website domain, QR code, or unknown.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceDescription",
"description": "Describes the source explicitly for first or last session.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceType",
"description": "Type of marketing tactic.",
"args": [],
"type": {
"kind": "ENUM",
"name": "MarketingTactic",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "utmParameters",
"description": "A set of UTM parameters gathered from the URL parameters of the referrer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "UTMParameters",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "CustomerMoment",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Date",
"description": "Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date string.\nFor example, September 7, 2019 is represented as `\"2019-07-16\"`.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "DateTime",
"description": "Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string.\nFor example, 3:30 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is\nrepresented as `\"2019-09-07T15:50:00Z`\".\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DayOfTheWeek",
"description": "Days of the week from Monday to Sunday.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MONDAY",
"description": "Monday.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TUESDAY",
"description": "Tuesday.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WEDNESDAY",
"description": "Wednesday.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "THURSDAY",
"description": "Thursday.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FRIDAY",
"description": "Friday.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SATURDAY",
"description": "Saturday.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SUNDAY",
"description": "Sunday.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Decimal",
"description": "A signed decimal number, which supports arbitrary precision and is serialized as a string.\n\nExample values: `\"29.99\"`, `\"29.999\"`.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeletionEvent",
"description": "Deletion events chronicle the destruction of resources (e.g. products and collections).\nOnce deleted, the deletion event is the only trace of the original's existence,\nas the resource itself has been removed and can no longer be accessed.\n",
"fields": [
{
"name": "occurredAt",
"description": "The date and time when the deletion event for the related resource was generated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subjectId",
"description": "The id of the resource that was deleted.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subjectType",
"description": "The type of resource that was deleted.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DeletionEventSubjectType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeletionEventConnection",
"description": "An auto-generated type for paginating through multiple DeletionEvents.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeletionEventEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeletionEventEdge",
"description": "An auto-generated type which holds one DeletionEvent and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DeletionEventEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeletionEvent",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DeletionEventSortKeys",
"description": "The set of valid sort keys for the DeletionEvent query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RELEVANCE",
"description": "During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the\nresults by relevance to the search term(s). When no search query is specified, this sort key is not\ndeterministic and should not be used.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DeletionEventSubjectType",
"description": "The supported subject types of deletion events.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "COLLECTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryAvailableService",
"description": "A shipping service and a list of countries that the service is available for.",
"fields": [
{
"name": "countries",
"description": "The countries the service provider ships to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCountryCodesOrRestOfWorld",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the service.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCarrierService",
"description": "A shipping service provider or a carrier account.",
"fields": [
{
"name": "availableServicesForCountries",
"description": "The list of services offered for given destinations.",
"args": [
{
"name": "origins",
"description": "The locations of the possible origins.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "countryCodes",
"description": "The country codes of the destinations.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "restOfWorld",
"description": "Whether to use 'Rest of World' as the destination.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryAvailableService",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "formattedName",
"description": "The properly formatted name of the shipping service provider, ready to display.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "icon",
"description": "The logo of the service provider.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the shipping service provider.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCarrierServiceAndLocations",
"description": "A carrier service and the associated list of shop locations.",
"fields": [
{
"name": "carrierService",
"description": "The carrier service.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCarrierService",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locations",
"description": "The list of locations that support this carrier service.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCondition",
"description": "A condition that must pass for a delivery method definition to be applied to an order.",
"fields": [
{
"name": "conditionCriteria",
"description": "The value (weight or price) that the condition field is compared to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DeliveryConditionCriteria",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "The field to compare the criterion value against, using the operator.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DeliveryConditionField",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "operator",
"description": "The operator to compare the field and criterion value.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DeliveryConditionOperator",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "DeliveryConditionCriteria",
"description": "The value (weight or price) that the condition field is compared to.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Weight",
"ofType": null
}
]
},
{
"kind": "ENUM",
"name": "DeliveryConditionField",
"description": "The field type that the condition will be applied to.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "TOTAL_WEIGHT",
"description": "The condition will check against the total weight of the order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOTAL_PRICE",
"description": "The condition will check against the total price of the order.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DeliveryConditionOperator",
"description": "The operator to use to determine if the condition passes.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GREATER_THAN_OR_EQUAL_TO",
"description": "The condition will check whether the field is greater than or equal to the criterion.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LESS_THAN_OR_EQUAL_TO",
"description": "The condition will check if the field is less than or equal to the criterion.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCountry",
"description": "A country that is used to define a shipping zone.",
"fields": [
{
"name": "code",
"description": "A two-letter country code in ISO 3166-1 alpha-2 standard.\nIt also includes a flag indicating whether the country should be\na part of the 'Rest Of World' shipping zone.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCountryCodeOrRestOfWorld",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The full name of the country.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "provinces",
"description": "The list of regions associated with this country.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProvince",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedName",
"description": "The translated name of the country. The translation returned is based on the system's locale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCountryAndZone",
"description": "The country details and the associated shipping zone.",
"fields": [
{
"name": "country",
"description": "The country details.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCountry",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "zone",
"description": "The name of the shipping zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCountryCodeOrRestOfWorld",
"description": "The country code and whether the country is a part of the 'Rest Of World' shipping zone.\n",
"fields": [
{
"name": "countryCode",
"description": "The country code in the ISO 3166-1 alpha-2 format.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restOfWorld",
"description": "Whether the country is a part of the 'Rest of World' shipping zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCountryCodesOrRestOfWorld",
"description": "The list of country codes and information whether the countries\nare a part of the 'Rest Of World' shipping zone.\n",
"fields": [
{
"name": "countryCodes",
"description": "List of applicable country codes in the ISO 3166-1 alpha-2 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restOfWorld",
"description": "Whether the countries are a part of the 'Rest of World' shipping zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryCountryInput",
"description": "Input fields to specify a country.",
"fields": null,
"inputFields": [
{
"name": "code",
"description": "The country code of the country in the ISO 3166-1 alpha-2 format.",
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"defaultValue": null
},
{
"name": "restOfWorld",
"description": "Whether the country is a part of the 'Rest of World' shipping zone.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "provinces",
"description": "The regions associated with this country.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryProvinceInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "includeAllProvinces",
"description": "Associate all available provinces with this country.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryLegacyModeBlocked",
"description": "Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned.",
"fields": [
{
"name": "blocked",
"description": "Whether the shop can convert to full multi-location delivery profiles mode.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reasons",
"description": "The reasons why the shop is blocked from converting to full multi-location delivery profiles mode.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DeliveryLegacyModeBlockedReason",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DeliveryLegacyModeBlockedReason",
"description": "Reasons the shop is blocked from converting to full multi-location delivery profiles mode.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MULTI_LOCATION_DISABLED",
"description": "Multi-Location is disabled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_LOCATIONS_FULFILLING_ONLINE_ORDERS",
"description": "No locations that can fulfill online orders.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryLocationGroup",
"description": "A location group is a collection of active locations. They share zones and delivery methods across delivery\nprofiles.\n",
"fields": [
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locations",
"description": "A list of active locations that are part of this location group.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "LocationSortKeys",
"ofType": null
},
"defaultValue": "NAME"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `active`\n - `address1`\n - `address2`\n - `city`\n - `country`\n - `legacy`\n - `name`\n - `province`\n - `zip`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "includeLegacy",
"description": "If true, also include the legacy locations of fulfillment services.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "includeInactive",
"description": "If true, also include the locations that are deactivated.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LocationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryLocationGroupZone",
"description": "Links a location group with a zone and the associated method definitions.",
"fields": [
{
"name": "methodDefinitionCounts",
"description": "The number of method definitions for the zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryMethodDefinitionCounts",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "methodDefinitions",
"description": "The method definitions associated to a zone and location group.",
"args": [
{
"name": "eligible",
"description": "Return only eligible or ineligible method definitions.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "type",
"description": "Return only merchant or participant method definitions.",
"type": {
"kind": "ENUM",
"name": "DeliveryMethodDefinitionType",
"ofType": null
},
"defaultValue": null
},
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "MethodDefinitionSortKeys",
"ofType": null
},
"defaultValue": "ID"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryMethodDefinitionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "zone",
"description": "The zone associated to a location group.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryZone",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryLocationGroupZoneConnection",
"description": "An auto-generated type for paginating through multiple DeliveryLocationGroupZones.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryLocationGroupZoneEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryLocationGroupZoneEdge",
"description": "An auto-generated type which holds one DeliveryLocationGroupZone and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DeliveryLocationGroupZoneEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryLocationGroupZone",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryLocationGroupZoneInput",
"description": "The input fields for a delivery zone associated to a location group and profile.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "A globally-unique identifier of the zone.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "name",
"description": "The name of the zone.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "countries",
"description": "A list of countries to associate with the zone.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryCountryInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "methodDefinitionsToCreate",
"description": "A list of method definitions to create.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryMethodDefinitionInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "methodDefinitionsToUpdate",
"description": "A list of method definitions to update.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryMethodDefinitionInput",
"ofType": null
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryMethod",
"description": "The delivery method used by a fulfillment order.",
"fields": [
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "methodType",
"description": "The type of the delivery method.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DeliveryMethodType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryMethodDefinition",
"description": "A method definition contains the delivery rate and the conditions that must be met for the method to be\napplied.\n",
"fields": [
{
"name": "active",
"description": "Whether this method definition is active.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "The description of the method definition.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "methodConditions",
"description": "The method conditions that must pass for this method definition to be applied to an order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCondition",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the method definition.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rateProvider",
"description": "The provided rate for this method definition, from a rate definition or participant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DeliveryRateProvider",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryMethodDefinitionConnection",
"description": "An auto-generated type for paginating through multiple DeliveryMethodDefinitions.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryMethodDefinitionEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryMethodDefinitionCounts",
"description": "The number of method definitions for a zone, separated into merchant-owned and participant definitions.\n",
"fields": [
{
"name": "participantDefinitionsCount",
"description": "The number of participant method definitions for the specified zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rateDefinitionsCount",
"description": "The number of merchant-defined method definitions for the specified zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryMethodDefinitionEdge",
"description": "An auto-generated type which holds one DeliveryMethodDefinition and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DeliveryMethodDefinitionEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryMethodDefinition",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryMethodDefinitionInput",
"description": "The input fields for a method definition.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "A globally-unique identifier of the method definition. Use only when updating a method definiton.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "name",
"description": "The name of the method definition.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "description",
"description": "The description of the method definition.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "active",
"description": "Whether to use this method definition during rate calculation.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "rateDefinition",
"description": "A rate definition to apply to the method definition.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DeliveryRateDefinitionInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "participant",
"description": "A participant to apply to the method definition.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DeliveryParticipantInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "weightConditionsToCreate",
"description": "A list of weight conditions on the method definition.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryWeightConditionInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "priceConditionsToCreate",
"description": "A list of price conditions on the method definition.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryPriceConditionInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "conditionsToUpdate",
"description": "A list of conditions to update on the method definition.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryUpdateConditionInput",
"ofType": null
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DeliveryMethodDefinitionType",
"description": "The different types of method definitions to filter by.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MERCHANT",
"description": "A static merchant-defined rate.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTICIPANT",
"description": "A dynamic participant rate.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DeliveryMethodType",
"description": "Possible method types that a delivery method can have.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SHIPPING",
"description": "The order is shipped.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PICK_UP",
"description": "The order is picked up by the customer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NONE",
"description": "No delivery is needed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RETAIL",
"description": "The order is delivered to a retail store.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LOCAL",
"description": "The order is delivered using a local delivery service.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryParticipant",
"description": "A participant defines carrier-calculated rates for shipping services\nwith a possible merchant-defined fixed fee or a percentage-of-rate fee.\n",
"fields": [
{
"name": "adaptToNewServicesFlag",
"description": "Whether to display new shipping services automatically to the customer when the service becomes available.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "carrierService",
"description": "The carrier used for this participant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCarrierService",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fixedFee",
"description": "The merchant-defined fixed fee for this participant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "participantServices",
"description": "The carrier-specific services offered by the participant, and whether each service is active.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryParticipantService",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "percentageOfRateFee",
"description": "The merchant-defined percentage-of-rate fee for this participant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryParticipantInput",
"description": "The input fields for a participant.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "A globally-unique identifier of the participant.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "carrierServiceId",
"description": "The `gid` of the `CarrierService` for this participant.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "fixedFee",
"description": "The fixed feed that is defined by the merchant for this participant.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "percentageOfRateFee",
"description": "The merchant-defined percentage-of-rate fee for this participant.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null
},
{
"name": "participantServices",
"description": "The list of shipping services offered by the participant.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryParticipantServiceInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "adaptToNewServices",
"description": "Whether to automatically display new shipping services to the customer when a service becomes available.\n",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryParticipantService",
"description": "A mail service provided by the participant.",
"fields": [
{
"name": "active",
"description": "Whether the service is active.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the service.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryParticipantServiceInput",
"description": "The input fields for a shipping service provided by a participant.",
"fields": null,
"inputFields": [
{
"name": "name",
"description": "The name of the service.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "active",
"description": "Whether the service is active.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryPriceConditionInput",
"description": "The input fields for a price-based condition of a delivery method definition.",
"fields": null,
"inputFields": [
{
"name": "criteria",
"description": "The monetary value to compare the price of an order to.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "operator",
"description": "The operator to use for comparison.",
"type": {
"kind": "ENUM",
"name": "DeliveryConditionOperator",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProductVariantsCount",
"description": "How many product variants are in a profile. This count is capped at 500.",
"fields": [
{
"name": "capped",
"description": "Whether the count has reached the cap of 500.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "count",
"description": "The product variant count.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfile",
"description": "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.\n",
"fields": [
{
"name": "activeMethodDefinitionsCount",
"description": "The number of active shipping rates for the profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "default",
"description": "Whether this is the default profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "legacyMode",
"description": "Whether this shop has enabled legacy compatibility mode for delivery profiles.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locationsWithoutRatesCount",
"description": "The number of locations without rates defined.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the delivery profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "originLocationCount",
"description": "The number of active origin locations for the profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantsCount",
"description": "The number of product variants for this profile. The count for the default profile is not supported and will return -1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `productVariantsCountV2` instead"
},
{
"name": "productVariantsCountV2",
"description": "How many product variants are in this profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProductVariantsCount",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "profileItems",
"description": "The products and variants associated with this profile.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key. This argument is deprecated: Profile item sorting is no longer supported.",
"type": {
"kind": "ENUM",
"name": "ProfileItemSortKeys",
"ofType": null
},
"defaultValue": "ID"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProfileItemConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "profileLocationGroups",
"description": "The location groups and associated zones using this profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProfileLocationGroup",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sellingPlanGroups",
"description": "Selling plan groups associated with the specified delivery profile.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SellingPlanGroupConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unassignedLocations",
"description": "List of locations that have not been assigned to a location group for this profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "zoneCountryCount",
"description": "The number of countries with active rates to deliver to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfileConnection",
"description": "An auto-generated type for paginating through multiple DeliveryProfiles.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProfileEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfileEdge",
"description": "An auto-generated type which holds one DeliveryProfile and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DeliveryProfileEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProfile",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryProfileInput",
"description": "The input fields for a delivery profile.",
"fields": null,
"inputFields": [
{
"name": "name",
"description": "The name of the delivery profile.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "profileLocationGroups",
"description": "The list of location groups associated with the delivery profile.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryProfileLocationGroupInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "locationGroupsToCreate",
"description": "The list of location groups to be created in the delivery profile.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryProfileLocationGroupInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "locationGroupsToUpdate",
"description": "The list of location groups to be updated in the delivery profile.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryProfileLocationGroupInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "locationGroupsToDelete",
"description": "The list of location groups to be deleted from the delivery profile.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "variantsToAssociate",
"description": "The list of product variant IDs to be associated with the delivery profile.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "variantsToDissociate",
"description": "The list of product variant IDs to be dissociated from the delivery profile.\nThe dissociated product variants are moved back to the default delivery profile.\n",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "zonesToDelete",
"description": "The list of zone IDs to delete.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "methodDefinitionsToDelete",
"description": "The list of method definition IDs to delete.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "conditionsToDelete",
"description": "The list of condition IDs to delete.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "sellingPlanGroupsToAssociate",
"description": "The list of selling plan groups to be associated with the delivery profile.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "sellingPlanGroupsToDissociate",
"description": "The list of selling plan groups to be dissociated with the delivery profile.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfileItem",
"description": "A product and the subset of associated variants that are part of this delivery profile.",
"fields": [
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "A product associated with this profile.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "The product variants associated with this delivery profile.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key. This argument is deprecated: Profile item variant sorting is no longer supported.",
"type": {
"kind": "ENUM",
"name": "ProductVariantSortKeys",
"ofType": null
},
"defaultValue": "ID"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfileItemConnection",
"description": "An auto-generated type for paginating through multiple DeliveryProfileItems.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProfileItemEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfileItemEdge",
"description": "An auto-generated type which holds one DeliveryProfileItem and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DeliveryProfileItemEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryProfileItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfileLocationGroup",
"description": "Links a location group with zones. Both are associated to a delivery profile.",
"fields": [
{
"name": "countriesInAnyZone",
"description": "The countries already selected in any zone for the specified location group.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCountryAndZone",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locationGroup",
"description": "The collection of locations that make up the specified location group.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryLocationGroup",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locationGroupZones",
"description": "The applicable zones associated to the specified location group.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryLocationGroupZoneConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryProfileLocationGroupInput",
"description": "The input fields for a location group associated to a delivery profile.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The globally-unique identifier of the delivery profile location group.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "locations",
"description": "The list of location IDs to be moved to this location group.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "zonesToCreate",
"description": "The list of location group zones to create.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryLocationGroupZoneInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "zonesToUpdate",
"description": "The list of location group zones to update.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DeliveryLocationGroupZoneInput",
"ofType": null
}
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProvince",
"description": "A region that is used to define a shipping zone.",
"fields": [
{
"name": "code",
"description": "The code of the region.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The full name of the region.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedName",
"description": "The translated name of the region. The translation returned is based on the system's locale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryProvinceInput",
"description": "The input fields to specify a region.",
"fields": null,
"inputFields": [
{
"name": "code",
"description": "The code of the region.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryRateDefinition",
"description": "The merchant-defined rate of the [DeliveryMethodDefinition](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryMethodDefinition).",
"fields": [
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The price of this rate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryRateDefinitionInput",
"description": "The input fields for a rate definition.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "A globally-unique identifier of the rate definition.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
},
{
"name": "price",
"description": "The price of the rate definition.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
}
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "DeliveryRateProvider",
"description": "A rate provided by a merchant-defined rate or a participant.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "DeliveryParticipant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryRateDefinition",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "DeliverySetting",
"description": "The `DeliverySetting` object enables you to manage shop-wide shipping settings.\nYou can enable legacy compatibility mode for the multi-location delivery profiles feature\nif the legacy mode isn't blocked.\n",
"fields": [
{
"name": "legacyModeBlocked",
"description": "Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryLegacyModeBlocked",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "legacyModeProfiles",
"description": "Enables legacy compatability mode for the multi-location delivery profiles feature.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliverySettingInput",
"description": "The input fields for shop-level delivery settings.",
"fields": null,
"inputFields": [
{
"name": "legacyModeProfiles",
"description": "Whether legacy compatability mode is enabled for the multi-location delivery profiles feature.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliverySettingUpdatePayload",
"description": "Return type for `deliverySettingUpdate` mutation.",
"fields": [
{
"name": "setting",
"description": "The updated delivery shop level settings.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DeliverySetting",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryShippingOriginAssignPayload",
"description": "Return type for `deliveryShippingOriginAssign` mutation.",
"fields": [
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryUpdateConditionInput",
"description": "The input fields for updating the condition of a delivery method definition.",
"fields": null,
"inputFields": [
{
"name": "id",
"description": "A globally-unique identifier of the condition.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "criteria",
"description": "The value that will be used in comparison.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null
},
{
"name": "criteriaUnit",
"description": "The unit associated with the value that will be used in comparison.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "field",
"description": "The property of an order that will be used in comparison.",
"type": {
"kind": "ENUM",
"name": "DeliveryConditionField",
"ofType": null
},
"defaultValue": null
},
{
"name": "operator",
"description": "The operator to use for comparison.",
"type": {
"kind": "ENUM",
"name": "DeliveryConditionOperator",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DeliveryWeightConditionInput",
"description": "The input fields for a weight-based condition of a delivery method definition.",
"fields": null,
"inputFields": [
{
"name": "criteria",
"description": "The weight value to compare the weight of an order to.",
"type": {
"kind": "INPUT_OBJECT",
"name": "WeightInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "operator",
"description": "The operator to use for comparison.",
"type": {
"kind": "ENUM",
"name": "DeliveryConditionOperator",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryZone",
"description": "A zone is a group of countries that have the same shipping rates. Customers can order products from a store only if they choose a shipping destination that's included in one of the store's zones.\n",
"fields": [
{
"name": "countries",
"description": "The list of countries within the zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCountry",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DigitalWallet",
"description": "Digital wallet, such as Apple Pay, which can be used for accelerated checkouts.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "APPLE_PAY",
"description": "Apple Pay.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ANDROID_PAY",
"description": "Android Pay.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GOOGLE_PAY",
"description": "Google Pay.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHOPIFY_PAY",
"description": "Shopify Pay.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAllocation",
"description": "An amount discounting the line that has been allocated by an associated discount application.\n",
"fields": [
{
"name": "allocatedAmount",
"description": "Money amount allocated by the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `allocatedAmountSet` instead"
},
{
"name": "allocatedAmountSet",
"description": "Money amount allocated by the discount application in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountApplication",
"description": "The discount of which this allocated amount originated from.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "DiscountApplication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAmount",
"description": "The fixed amount value of a discount.",
"fields": [
{
"name": "amount",
"description": "The value of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliesOnEachItem",
"description": "If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DiscountAmountInput",
"description": "Specifies the value of the discount and how it is applied.",
"fields": null,
"inputFields": [
{
"name": "amount",
"description": "The value of the discount.",
"type": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
},
"defaultValue": null
},
{
"name": "appliesOnEachItem",
"description": "If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "DiscountApplication",
"description": "Discount applications capture the intentions of a discount source at\nthe time of application on an order's line items or shipping lines.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "index",
"description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AutomaticDiscountApplication",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeApplication",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ManualDiscountApplication",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ScriptDiscountApplication",
"ofType": null
}
]
},
{
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"description": "The method by which the discount's value is allocated onto its entitled lines.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACROSS",
"description": "The value is spread across all entitled lines.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EACH",
"description": "The value is applied onto every entitled line.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ONE",
"description": "The value is specifically applied onto a particular line.",
"isDeprecated": true,
"deprecationReason": "Use ACROSS instead."
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountApplicationConnection",
"description": "An auto-generated type for paginating through multiple DiscountApplications.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountApplicationEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountApplicationEdge",
"description": "An auto-generated type which holds one DiscountApplication and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DiscountApplicationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "DiscountApplication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DiscountApplicationLevel",
"description": "The method by which the discount's value is allocated onto its entitled lines.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ORDER",
"description": "The discount was applied at the order level.\nOrder level discounts are not factored into the discountedUnitPriceSet on line items.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LINE",
"description": "The discount was applied at the line level.\nLine level discounts are factored into the discountedUnitPriceSet on line items.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"description": "Which lines on the order that the discount is allocated over, of the type\ndefined by the Discount Application's target_type.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALL",
"description": "The discount is allocated onto all the lines.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENTITLED",
"description": "The discount is allocated onto only the lines it is entitled for.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPLICIT",
"description": "The discount is allocated onto explicitly chosen lines.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"description": "The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "LINE_ITEM",
"description": "The discount applies onto line items.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_LINE",
"description": "The discount applies onto shipping lines.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "UNION",
"name": "DiscountAutomatic",
"description": "An automatic discount.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "DiscountAutomaticBasic",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBxgy",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticActivatePayload",
"description": "Return type for `discountAutomaticActivate` mutation.",
"fields": [
{
"name": "automaticDiscountNode",
"description": "The activated automatic discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBasic",
"description": "An automatic basic discount.",
"fields": [
{
"name": "asyncUsageCount",
"description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the discount was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCustomerGets",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumRequirement",
"description": "The minimum subtotal or quantity that's required for the discount to be applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountMinimumRequirement",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shortSummary",
"description": "A short summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "summary",
"description": "A detailed summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageCount",
"description": "The number of times that the discount has been used.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `asyncUsageCount` instead"
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBasicCreatePayload",
"description": "Return type for `discountAutomaticBasicCreate` mutation.",
"fields": [
{
"name": "automaticDiscountNode",
"description": "The created automatic discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DiscountAutomaticBasicInput",
"description": "Specifies input field to create or update automatic basic discount.",
"fields": null,
"inputFields": [
{
"name": "title",
"description": "The title of the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "minimumRequirement",
"description": "The minimum subtotal or quantity that's required for the discount to be applied.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountMinimumRequirementInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerGetsInput",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBasicUpdatePayload",
"description": "Return type for `discountAutomaticBasicUpdate` mutation.",
"fields": [
{
"name": "automaticDiscountNode",
"description": "The updated automatic discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBulkDeletePayload",
"description": "Return type for `discountAutomaticBulkDelete` mutation.",
"fields": [
{
"name": "job",
"description": "The asynchronous job removing the automatic discounts.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBxgy",
"description": "An automatic BXGY discount.",
"fields": [
{
"name": "asyncUsageCount",
"description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the discount was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerBuys",
"description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCustomerBuys",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCustomerGets",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "The paginated list of events associated with the host subject.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "EventSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A legacy unique identifier for the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use DiscountAutomaticNode.id instead."
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "summary",
"description": "A detailed summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageCount",
"description": "The number of times that the discount has been used.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `asyncUsageCount` instead"
},
{
"name": "usesPerOrderLimit",
"description": "The maximum number of times that the discount can be applied to an order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "HasEvents",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBxgyCreatePayload",
"description": "Return type for `discountAutomaticBxgyCreate` mutation.",
"fields": [
{
"name": "automaticDiscountNode",
"description": "The created automatic discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DiscountAutomaticBxgyInput",
"description": "Specifies input field to create or update automatic bogo discount.",
"fields": null,
"inputFields": [
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "title",
"description": "The title of the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "usesPerOrderLimit",
"description": "The maximum number of times that the discount can be applied to an order.",
"type": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerBuys",
"description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerBuysInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerGetsInput",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBxgyUpdatePayload",
"description": "Return type for `discountAutomaticBxgyUpdate` mutation.",
"fields": [
{
"name": "automaticDiscountNode",
"description": "The updated automatic discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticConnection",
"description": "An auto-generated type for paginating through multiple DiscountAutomatics.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountAutomaticEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticDeactivatePayload",
"description": "Return type for `discountAutomaticDeactivate` mutation.",
"fields": [
{
"name": "automaticDiscountNode",
"description": "The deactivated automatic discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticDeletePayload",
"description": "Return type for `discountAutomaticDelete` mutation.",
"fields": [
{
"name": "deletedAutomaticDiscountId",
"description": "The deleted automatic discount ID.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticEdge",
"description": "An auto-generated type which holds one DiscountAutomatic and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DiscountAutomaticEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountAutomatic",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"description": "An automatic discount wrapper node.",
"fields": [
{
"name": "automaticDiscount",
"description": "An automatic discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountAutomatic",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "The paginated list of events associated with the host subject.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "EventSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "HasEvents",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticNodeConnection",
"description": "An auto-generated type for paginating through multiple DiscountAutomaticNodes.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountAutomaticNodeEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticNodeEdge",
"description": "An auto-generated type which holds one DiscountAutomaticNode and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DiscountAutomaticNodeEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "DiscountCode",
"description": "A code discount.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "DiscountCodeBasic",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBxgy",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeFreeShipping",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "DiscountCodeActivatePayload",
"description": "Return type for `discountCodeActivate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The activated code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeApplication",
"description": "Discount code applications capture the intentions of a discount code at\nthe time that it is applied onto an order.\n",
"fields": [
{
"name": "allocationMethod",
"description": "The method by which the discount's value is allocated to its entitled items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationAllocationMethod",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The string identifying the discount code that was used at the time of application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "index",
"description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSelection",
"description": "How the discount amount is distributed on the discounted lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetType",
"description": "Whether the discount is applied on line items or shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountApplicationTargetType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of the discount application.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "PricingValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "DiscountApplication",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBasic",
"description": "A basic code discount.",
"fields": [
{
"name": "appliesOncePerCustomer",
"description": "Whether the discount can be applied only once per customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "asyncUsageCount",
"description": "The number of times that the discount has been used.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codeCount",
"description": "The number of redeem codes for the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codes",
"description": "A list of redeem codes for the discount.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "DiscountCodeSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountRedeemCodeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the discount was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCustomerGets",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerSelection",
"description": "The customers that can use the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountCustomerSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasTimelineComment",
"description": "Indicates whether there are any timeline comments on the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumRequirement",
"description": "The minimum subtotal or quantity that's required for the discount to be applied.",
"args": [],
"type": {
"kind": "UNION",
"name": "DiscountMinimumRequirement",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recurringCycleLimit",
"description": "The number of times a discount applies on recurring purchases (subscriptions).",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shareableUrls",
"description": "URLs that can be used to share the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountShareableUrl",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shortSummary",
"description": "A short summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "summary",
"description": "A detailed summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalSales",
"description": "The total sales from orders where the discount was used.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageLimit",
"description": "The maximum number of times that the discount can be used.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBasicCreatePayload",
"description": "Return type for `discountCodeBasicCreate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The created code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DiscountCodeBasicInput",
"description": "Specifies input field to create or update code basic discount.",
"fields": null,
"inputFields": [
{
"name": "title",
"description": "The title of the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "usageLimit",
"description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "appliesOncePerCustomer",
"description": "Whether the discount can be applied only once per customer.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "minimumRequirement",
"description": "The minimum subtotal or quantity that's required for the discount to be applied.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountMinimumRequirementInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerGetsInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerSelection",
"description": "The customers that can use the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerSelectionInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "code",
"description": "The code to use the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "recurringCycleLimit",
"description": "The number of times a discount applies on recurring purchases (subscriptions).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBasicUpdatePayload",
"description": "Return type for `discountCodeBasicUpdate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The updated code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBulkActivatePayload",
"description": "Return type for `discountCodeBulkActivate` mutation.",
"fields": [
{
"name": "job",
"description": "The asynchronous job that activates the code discounts.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBulkDeactivatePayload",
"description": "Return type for `discountCodeBulkDeactivate` mutation.",
"fields": [
{
"name": "job",
"description": "The asynchronous job that deactivates the code discounts.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBulkDeletePayload",
"description": "Return type for `discountCodeBulkDelete` mutation.",
"fields": [
{
"name": "job",
"description": "The asynchronous job that deletes the code discounts.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBxgy",
"description": "A BXGY code discount.",
"fields": [
{
"name": "appliesOncePerCustomer",
"description": "Whether the discount can be applied only once per customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "asyncUsageCount",
"description": "The number of times that the discount has been used.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codeCount",
"description": "The number of redeem codes for the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codes",
"description": "A list of redeem codes for the discount.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "DiscountCodeSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountRedeemCodeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the discount was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerBuys",
"description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCustomerBuys",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCustomerGets",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerSelection",
"description": "The customers that can use the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountCustomerSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasTimelineComment",
"description": "Indicates whether there are any timeline comments on the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shareableUrls",
"description": "URLs that can be used to share the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountShareableUrl",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "summary",
"description": "A detailed summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalSales",
"description": "The total sales from orders where the discount was used.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageLimit",
"description": "The maximum number of times that the discount can be used.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usesPerOrderLimit",
"description": "The maximum number of times that the discount can be applied to an order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBxgyCreatePayload",
"description": "Return type for `discountCodeBxgyCreate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The created code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DiscountCodeBxgyInput",
"description": "Specifies input field to create or update a BXGY code discount.",
"fields": null,
"inputFields": [
{
"name": "title",
"description": "The title of the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerBuys",
"description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerBuysInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerGets",
"description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerGetsInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerSelection",
"description": "The customers that can use the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerSelectionInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "code",
"description": "The code to use the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "usageLimit",
"description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "usesPerOrderLimit",
"description": "The maximum number of times that the discount can be applied to an order.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "appliesOncePerCustomer",
"description": "Whether the discount can be applied only once per customer.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeBxgyUpdatePayload",
"description": "Return type for `discountCodeBxgyUpdate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The updated code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeDeactivatePayload",
"description": "Return type for `discountCodeDeactivate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The deactivated code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeDeletePayload",
"description": "Return type for `discountCodeDelete` mutation.",
"fields": [
{
"name": "deletedCodeDiscountId",
"description": "The deleted code discount ID.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeFreeShipping",
"description": "A free shipping code discount.",
"fields": [
{
"name": "appliesOnOneTimePurchase",
"description": "Whether the discount applies on regular one-time-purchase shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliesOnSubscription",
"description": "Whether the discount applies on subscription shipping lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appliesOncePerCustomer",
"description": "Whether the discount can be applied only once per customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "asyncUsageCount",
"description": "The number of times that the discount has been used.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codeCount",
"description": "The number of redeem codes for the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codes",
"description": "A list of redeem codes for the discount.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "DiscountCodeSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountRedeemCodeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the discount was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerSelection",
"description": "The customers that can use the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountCustomerSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "destinationSelection",
"description": "A shipping destination that qualifies for the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountShippingDestinationSelection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasTimelineComment",
"description": "Indicates whether there are any timeline comments on the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumShippingPrice",
"description": "The maximum shipping price amount accepted to qualify for the discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumRequirement",
"description": "The minimum subtotal or quantity that's required for the discount to be applied.",
"args": [],
"type": {
"kind": "UNION",
"name": "DiscountMinimumRequirement",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recurringCycleLimit",
"description": "The number of times a discount applies on recurring purchases (subscriptions).",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shareableUrls",
"description": "URLs that can be used to share the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountShareableUrl",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shortSummary",
"description": "A short summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The status of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "summary",
"description": "A detailed summary of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalSales",
"description": "The total sales from orders where the discount was used.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageLimit",
"description": "The maximum number of times that the discount can be used.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeFreeShippingCreatePayload",
"description": "Return type for `discountCodeFreeShippingCreate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The created code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DiscountCodeFreeShippingInput",
"description": "Specifies input field to create or update free shipping code discount.",
"fields": null,
"inputFields": [
{
"name": "title",
"description": "The title of the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "startsAt",
"description": "The date and time when the discount starts.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "endsAt",
"description": "The date and time when the discount ends. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null
},
{
"name": "code",
"description": "The code to use the discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "usageLimit",
"description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "appliesOncePerCustomer",
"description": "Whether the discount can be applied only once per customer.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "minimumRequirement",
"description": "The minimum subtotal or quantity that's required for the discount to be applied.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountMinimumRequirementInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "customerSelection",
"description": "The customers that can use the discount.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountCustomerSelectionInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "destination",
"description": "A list of destinations where the discount will apply.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DiscountShippingDestinationSelectionInput",
"ofType": null
},
"defaultValue": null
},
{
"name": "maximumShippingPrice",
"description": "The maximum shipping price that qualifies for the discount.",
"type": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
},
"defaultValue": null
},
{
"name": "recurringCycleLimit",
"description": "The number of times a discount applies on recurring purchases (subscriptions).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "appliesOnOneTimePurchase",
"description": "Whether the discount applies on regular one-time-purchase items.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "appliesOnSubscription",
"description": "Whether the discount applies on subscription items.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeFreeShippingUpdatePayload",
"description": "Return type for `discountCodeFreeShippingUpdate` mutation.",
"fields": [
{
"name": "codeDiscountNode",
"description": "The updated code discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeNode",
"description": "A code discount wrapper node.",
"fields": [
{
"name": "codeDiscount",
"description": "A code discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "DiscountCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "The paginated list of events associated with the host subject.",
"args": [
{
"name": "first",
"description": "Returns up to the first `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "after",
"description": "Returns the elements that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "last",
"description": "Returns up to the last `n` elements from the list.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "before",
"description": "Returns the elements that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "reverse",
"description": "Reverse the order of the underlying list.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "sortKey",
"description": "Sort the underlying list by the given key.",
"type": {
"kind": "ENUM",
"name": "EventSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A globally-unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "HasEvents",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeNodeConnection",
"description": "An auto-generated type for paginating through multiple DiscountCodeNodes.\n",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCodeNodeEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Information to aid in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeNodeEdge",
"description": "An auto-generated type which holds one DiscountCodeNode and a cursor during pagination.\n",
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of DiscountCodeNodeEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeRedeemCodeBulkDeletePayload",
"description": "Return type for `discountCodeRedeemCodeBulkDelete` mutation.",
"fields": [
{
"name": "job",
"description": "The asynchronous job that deletes the discount redeem codes.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userErrors",
"description": "The list of errors that occurred from executing the mutation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"i
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment