Skip to content

Instantly share code, notes, and snippets.

@tuldok89

tuldok89/shopify.json

Last active February 6, 2022 08:55
Show Gist options
  • Save tuldok89/cf99b808ba0168054970bc60fbfb25c4 to your computer and use it in GitHub Desktop.
Save tuldok89/cf99b808ba0168054970bc60fbfb25c4 to your computer and use it in GitHub Desktop.
Download ZIP
Shopify JSON Schema
Raw
shopify.json
This file has been truncated, but you can view the full file.
{
"__schema": {
"queryType": {
"name": "QueryRoot"
},
"mutationType": {
"name": "Mutation"
},
"subscriptionType": null,
"types": [
{
"kind": "SCALAR",
"name": "Boolean",
"description": "Represents `true` or `false` values.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "String",
"description": "Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "QueryRoot",
"description": "The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.",
"fields": [
{
"name": "app",
"description": "Lookup an App by ID or return the currently authenticated App.",
"args": [
{
"name": "id",
"description": "The ID to lookup the App by.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appByHandle",
"description": "Fetches app by handle.\nReturns null if the app doesn't exist.\n",
"args": [
{
"name": "handle",
"description": "Handle of the App.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appByKey",
"description": "Fetches app by apiKey.\nReturns null if the app doesn't exist.\n",
"args": [
{
"name": "apiKey",
"description": "API key of the App.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appInstallation",
"description": "Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.",
"args": [
{
"name": "id",
"description": "ID used to lookup AppInstallation.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appInstallations",
"description": "List of app installations.",
"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": "AppInstallationSortKeys",
"ofType": null
},
"defaultValue": "INSTALLED_AT"
},
{
"name": "category",
"description": "The category of app installations to fetch.",
"type": {
"kind": "ENUM",
"name": "AppInstallationCategory",
"ofType": null
},
"defaultValue": null
},
{
"name": "privacy",
"description": "The privacy level of app installations to fetch.",
"type": {
"kind": "ENUM",
"name": "AppInstallationPrivacy",
"ofType": null
},
"defaultValue": "PUBLIC"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppInstallationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticDiscount",
"description": "Returns an automatic discount resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the DiscountAutomatic to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "UNION",
"name": "DiscountAutomatic",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `automaticDiscountNode` instead"
},
{
"name": "automaticDiscountNode",
"description": "Returns an automatic discount resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the DiscountAutomaticNode to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticDiscountNodes",
"description": "List of automatic discounts.",
"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": "AutomaticDiscountSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `status`\n - `type`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountAutomaticNodeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticDiscountSavedSearches",
"description": "List of the shop's automatic discount saved searches.",
"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": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticDiscounts",
"description": "List of automatic discounts.",
"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": "AutomaticDiscountSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `status`\n - `type`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountAutomaticConnection",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `automaticDiscountNodes` instead"
},
{
"name": "availableCarrierServices",
"description": "List of activated carrier services and which shop locations support them.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCarrierServiceAndLocations",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "carrierService",
"description": "Lookup a carrier service by ID.",
"args": [
{
"name": "id",
"description": "The ID of the DeliveryCarrierService to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "DeliveryCarrierService",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Lookup a channel by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Channel to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `publication` instead"
},
{
"name": "channels",
"description": "List of the active sales channels.",
"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 `publications` instead"
},
{
"name": "codeDiscountNode",
"description": "Returns a code discount resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the DiscountCodeNode to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codeDiscountNodeByCode",
"description": "Returns a code discount identified by its code.",
"args": [
{
"name": "code",
"description": "The code of the DiscountCodeNode to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codeDiscountNodes",
"description": "List of code discounts. Special fields for query params:\n * status: active, expired, scheduled\n * type: bxgy, fixed_amount, free_shipping, percentage.",
"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": "CodeDiscountSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `created_at`\n - `ends_at`\n - `starts_at`\n - `status`\n - `times_used`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountCodeNodeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "codeDiscountSavedSearches",
"description": "List of the shop's code discount saved searches.",
"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": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collection",
"description": "Returns a Collection resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Collection to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionByHandle",
"description": "Return a collection by its handle.",
"args": [
{
"name": "handle",
"description": "The handle of the collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionRulesConditions",
"description": "A list of rule conditions to define how collections with rules can be created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionRuleConditions",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionSavedSearches",
"description": "List of the shop's collection saved searches.",
"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": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "List of collections.",
"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": "CollectionSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `collection_type`\n - `published_status`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currentAppInstallation",
"description": "Return the AppInstallation for the currently authenticated App.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currentBulkOperation",
"description": "Returns the current app's most recent BulkOperation.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "BulkOperation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customer",
"description": "Returns a Customer resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Customer to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerSavedSearches",
"description": "List of the shop's customer saved searches.",
"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": "CustomerSavedSearchSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `name`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customers",
"description": "List of customers.",
"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": "CustomerSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `accepts_marketing`\n - `country`\n - `customer_date`\n - `email`\n - `last_abandoned_order_date`\n - `order_date`\n - `orders_count`\n - `phone`\n - `state`\n - `tag`\n - `total_spent`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deletionEvents",
"description": "The paginated list of deletion events.",
"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": "DeletionEventSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `occurred_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "subjectTypes",
"description": "List of subject types to filter by.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DeletionEventSubjectType",
"ofType": null
}
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeletionEventConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deliveryProfile",
"description": "Lookup a Delivery Profile by ID.",
"args": [
{
"name": "id",
"description": "The ID of the DeliveryProfile to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "DeliveryProfile",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deliveryProfiles",
"description": "List of saved delivery profiles.",
"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": "DeliveryProfileConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deliverySettings",
"description": "The shop-wide shipping settings.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DeliverySetting",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "domain",
"description": "Lookup a Domain by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Domain to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Domain",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrder",
"description": "Returns a DraftOrder resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the DraftOrder to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "DraftOrder",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrderSavedSearches",
"description": "List of the shop's draft order saved searches.",
"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": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrders",
"description": "List of saved draft 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": "DraftOrderSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `created_at`\n - `customer_id`\n - `status`\n - `tag`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DraftOrderConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillment",
"description": "Returns a Fulfillment resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Fulfillment to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryItem",
"description": "Returns an InventoryItem resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the InventoryItem to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "InventoryItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryItems",
"description": "List of inventory items.",
"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 - `created_at`\n - `id`\n - `sku`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InventoryItemConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryLevel",
"description": "Returns an InventoryLevel resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the InventoryLevel to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "InventoryLevel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "job",
"description": "Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.\n",
"args": [
{
"name": "id",
"description": "ID of the job to query",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Job",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "location",
"description": "Returns an inventory Location resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locations",
"description": "List of active locations.",
"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://help.shopify.com/api/getting-started/search-syntax).\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
},
{
"name": "locationsAvailableForDeliveryProfiles",
"description": "Returns a list of all origin locations available for a delivery profile.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
}
}
},
"isDeprecated": true,
"deprecationReason": "Use `locationsAvailableForDeliveryProfilesConnection` instead"
},
{
"name": "locationsAvailableForDeliveryProfilesConnection",
"description": "Returns a list of all origin locations available for a 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": "LocationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingActivities",
"description": "List of a campaign's marketing activities.",
"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": "MarketingActivitySortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `app_id`\n - `created_at`\n - `marketing_campaign_id`\n - `tactic`\n - `title`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MarketingActivityConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingActivity",
"description": "Returns a MarketingActivity resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the MarketingActivity to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "MarketingActivity",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingEvent",
"description": "Returns a MarketingEvent resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the MarketingEvent to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "MarketingEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "marketingEvents",
"description": "List of marketing events.",
"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": "MarketingEventSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `app_id`\n - `description`\n - `started_at`\n - `type`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MarketingEventConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafieldStorefrontVisibilities",
"description": "List of metafield namespaces and keys visible to the Storefront API.",
"args": [
{
"name": "namespace",
"description": "Filter the metafields storefront whitelist 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": "MetafieldStorefrontVisibilityConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafieldStorefrontVisibility",
"description": "Returns metafield storefront visibility by ID.",
"args": [
{
"name": "id",
"description": "The ID of the MetafieldStorefrontVisibility to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "MetafieldStorefrontVisibility",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "Returns a specific node by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Node to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "nodes",
"description": "Returns the list of nodes with the given IDs.",
"args": [
{
"name": "ids",
"description": "The IDs of the Nodes to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Returns an Order resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Order to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderSavedSearches",
"description": "List of the shop's order saved searches.",
"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": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orders",
"description": "List of orders placed.",
"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": "PROCESSED_AT"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `cart_token`\n - `channel_id`\n - `chargeback_status`\n - `checkout_token`\n - `created_at`\n - `credit_card_last4`\n - `customer_id`\n - `discount_code`\n - `email`\n - `financial_status`\n - `fraud_protection_level`\n - `fulfillment_status`\n - `location_id`\n - `processed_at`\n - `reference_location_id`\n - `risk_level`\n - `sales_channel`\n - `source_name`\n - `status`\n - `tag`\n - `test`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceRule",
"description": "Lookup a price rule by ID.",
"args": [
{
"name": "id",
"description": "The ID of the PriceRule to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "PriceRule",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceRuleSavedSearches",
"description": "List of the shop's price rule saved searches.",
"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": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceRules",
"description": "List of price rules.",
"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": "PriceRuleSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `created_at`\n - `discount_type`\n - `ends_at`\n - `starts_at`\n - `status`\n - `times_used`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PriceRuleConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "Returns a private metafield by ID.",
"args": [
{
"name": "id",
"description": "The ID of the PrivateMetafield to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "PrivateMetafield",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "List of private metafields.",
"args": [
{
"name": "namespace",
"description": "Filter the private metafields by namespace.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "owner",
"description": "Retrieve the private metafields of a certain resource, specified by the resource ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"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": "product",
"description": "Returns a Product resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Product to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productByHandle",
"description": "Return a product by its handle.",
"args": [
{
"name": "handle",
"description": "The handle of the product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productSavedSearches",
"description": "List of the shop's product saved searches.",
"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": "SavedSearchConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Returns a ProductVariant resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the ProductVariant to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariants",
"description": "List of the product variants.",
"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": "ProductVariantSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `barcode`\n - `collection`\n - `delivery_profile_id`\n - `gift_card`\n - `inventory_quantity`\n - `location_id`\n - `managed`\n - `managed_by`\n - `product_id`\n - `product_type`\n - `published_status`\n - `sku`\n - `tag`\n - `taxable`\n - `title`\n - `updated_at`\n - `vendor`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products.",
"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": "ProductSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `barcode`\n - `created_at`\n - `delivery_profile_id`\n - `error_feedback`\n - `gift_card`\n - `inventory_total`\n - `out_of_stock_somewhere`\n - `product_type`\n - `published_status`\n - `sku`\n - `tag`\n - `title`\n - `updated_at`\n - `vendor`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "savedSearchId",
"description": "ID of an existing saved search.\nThe searchΓÇÖs query string will be used as the query argument.\n",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicApiVersions",
"description": "The list of public Admin API versions, including supported, release candidate and unstable versions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ApiVersion",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publication",
"description": "Lookup a publication by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Publication to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Publication",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publications",
"description": "List of the active publications.",
"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": "refund",
"description": "Returns a Refund resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the Refund to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "Refund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "scriptTag",
"description": "Lookup a script tag resource by ID.",
"args": [
{
"name": "id",
"description": "The ID of the ScriptTag to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "ScriptTag",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "scriptTags",
"description": "List of script tags.",
"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": "src",
"description": "The source URL of the script tag to filter by.",
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ScriptTagConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Returns a Shop resource corresponding to access token used in request.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopLocales",
"description": "List of locales available on a shop.",
"args": [
{
"name": "published",
"description": "Return only published locales.",
"type": {
"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": "ShopLocale",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopifyPaymentsAccount",
"description": "Shopify Payments account information, including balances and payouts.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShopifyPaymentsAccount",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tenderTransactions",
"description": "List of TenderTransactions associated with the 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": "query",
"description": "Supported filter parameters:\n - `processed_at`\n - `test`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TenderTransactionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatableResource",
"description": "Translatable resource.",
"args": [
{
"name": "resourceId",
"description": "Find a translatable resource by ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "TranslatableResource",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatableResources",
"description": "List of translatable resources.",
"args": [
{
"name": "resourceType",
"description": "Return only resources of a type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TranslatableResourceType",
"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": "TranslatableResourceConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookSubscription",
"description": "Returns a webhook subscription by ID.",
"args": [
{
"name": "id",
"description": "The ID of the WebhookSubscription to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "WebhookSubscription",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookSubscriptions",
"description": "List of webhook subscriptions.",
"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": "WebhookSubscriptionSortKeys",
"ofType": null
},
"defaultValue": "CREATED_AT"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `created_at`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
},
{
"name": "callbackUrl",
"description": "Callback URL to filter by.",
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"defaultValue": null
},
{
"name": "format",
"description": "Response format to filter by.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionFormat",
"ofType": null
},
"defaultValue": null
},
{
"name": "topics",
"description": "List of webhook subscription topics to filter by.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"ofType": null
}
}
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookSubscriptionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Job",
"description": "A job corresponds to some long running task that the client should poll for status.",
"fields": [
{
"name": "done",
"description": "This indicates if the job is still queued or has been run.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "QueryRoot",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "ID",
"description": "Represents a unique identifier, often used to refetch an object or as key for a cache.\nThe ID type appears in a JSON response as a String, but it is not intended to be human-readable.\nWhen expected as an input type, any string (such as \"4\") or integer (such as 4) input value will be accepted as an ID.\n\nAdmin API example value: `\"gid://shopify/Product/10079785100\"`.\n\nStorefront API example value: `\"Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzEwMDc5Nzg1MTAw\"`.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Node",
"description": "An object with an ID to support global identification.",
"fields": [
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "App",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppCredit",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppPurchaseOneTime",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppSubscription",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppUsageRecord",
"ofType": null
},
{
"kind": "OBJECT",
"name": "BasicEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "BulkOperation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CommentEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CustomerVisit",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryCarrierService",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryCondition",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryCountry",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryLocationGroup",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryMethodDefinition",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryParticipant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfile",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryProvince",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryRateDefinition",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryZone",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBxgy",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Domain",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrder",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrderLineItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
{
"kind": "OBJECT",
"name": "FulfillmentEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "FulfillmentLineItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "InventoryItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "InventoryLevel",
"ofType": null
},
{
"kind": "OBJECT",
"name": "LineItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Location",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MailingAddress",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MarketingActivity",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MarketingEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Metafield",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MetafieldStorefrontVisibility",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OnlineStoreArticle",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OnlineStoreBlog",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OnlineStorePage",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderDisputeSummary",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderTransaction",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PriceRule",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PriceRuleDiscountCode",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PrivateMetafield",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductOption",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Publication",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Refund",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SavedSearch",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ScriptTag",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopifyPaymentsAccount",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopifyPaymentsBankAccount",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopifyPaymentsDispute",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopifyPaymentsPayout",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopifyPaymentsVerification",
"ofType": null
},
{
"kind": "OBJECT",
"name": "StorefrontAccessToken",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TenderTransaction",
"ofType": null
},
{
"kind": "OBJECT",
"name": "WebhookSubscription",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "Order",
"description": "An order represents an agreement to do business between a customer and a merchant.",
"fields": [
{
"name": "alerts",
"description": "Generated messages that appear at the top of an order page in the Shopify admin.\nFor example, _this is a test order_.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ResourceAlert",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "billingAddress",
"description": "Mailing address provided by the customer.\nNot all orders have mailing addresses.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MailingAddress",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "billingAddressMatchesShippingAddress",
"description": "Whether the billing address matches the shipping address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canMarkAsPaid",
"description": "Whether the order can be manually marked as paid.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canNotifyCustomer",
"description": "Whether notifications can be sent to the customer or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cancelReason",
"description": "Reason the order was canceled.\nReturns null if the order wasn't canceled.\n",
"args": [],
"type": {
"kind": "ENUM",
"name": "OrderCancelReason",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cancelledAt",
"description": "Date and time when the order was canceled.\nReturns null if the order wasn't canceled.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "capturable",
"description": "Whether payment for the order can be captured.\nReturns true when the customer's credit card has been authorized for payment and the authorization period has not expired.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cartDiscountAmount",
"description": "Amount of the order-level discount (does not contain any line item discounts).",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `cartDiscountAmountSet` instead"
},
{
"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": "channel",
"description": "Channel that created the order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `publication` instead"
},
{
"name": "clientIp",
"description": "The ip address of the client that is associated with this order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "closed",
"description": "Whether the order is closed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "closedAt",
"description": "Date and time when the order closed.\nIf the order is not closed, then this field is null.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "confirmed",
"description": "Whether inventory has been reserved for the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "Date and time when the order was created in Shopify.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currencyCode",
"description": "The currency of the store at the time of the order.\nIf payment hasn't occurred, then this field is null.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CurrencyCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customAttributes",
"description": "Custom information added to the order by your customer\n(Also referred to as note attributes).\n",
"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": "customer",
"description": "Unique identifier of the customer who placed the order.\nNot all orders have customers associated with them.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerAcceptsMarketing",
"description": "Whether the customer agreed to receive marketing materials.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerJourney",
"description": "Description of the customer's experience with the store leading up to the order.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CustomerJourney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerLocale",
"description": "A two-letter or three-letter language code, optionally followed by a region modifier.\nExample values could be 'en', 'en-CA', 'en-PIRATE'.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountApplications",
"description": "Discounts that have been applied on the order.",
"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": "DiscountApplicationConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountCode",
"description": "Discount code provided by the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayAddress",
"description": "Primary address of the customer, which is shown on the order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MailingAddress",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayFinancialStatus",
"description": "Financial status of the order that can be shown to the merchant.\nThis field does not capture all the possible details of an order's financial state and should only be used for display summary purposes.\n",
"args": [],
"type": {
"kind": "ENUM",
"name": "OrderDisplayFinancialStatus",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayFulfillmentStatus",
"description": "Fulfillment status for the order that can be shown to the merchant.\nThis field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDisplayFulfillmentStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "disputes",
"description": "Summary of each dispute associated with the order. Sorted in ascending (ASC) order by ID.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderDisputeSummary",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftFulfillments",
"description": "List of possible fulfilments that can be made for the order (includes line items that can be partially fulfilled).\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DraftFulfillment",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email address provided by the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "List of internal events associated with the order.",
"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://help.shopify.com/api/getting-started/search-syntax).\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": "fulfillable",
"description": "Whether there are items that can be fulfilled.\nAfter an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillments",
"description": "List of shipments for the order.",
"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": "Fulfillment",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fullyPaid",
"description": "Whether the order has been paid in full.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasTimelineComment",
"description": "Whether the merchant added timeline comments to the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "landingPageDisplayText",
"description": "First page of the online store that the customer visited before they submitted the order, for displaying to humans.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `customerJourney.lastVisit.landingPageHtml` instead"
},
{
"name": "landingPageUrl",
"description": "First page of the online store that the customer visited before they submitted the order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `customerJourney.lastVisit.landingPage` instead"
},
{
"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": "lineItems",
"description": "List of the order's line items.",
"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": "LineItemConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "location",
"description": "If the order was processed using Shopify POS, then this is its location as provided by the merchant.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `physicalLocation` instead"
},
{
"name": "merchantEditable",
"description": "Whether the order can be edited or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "The metafield associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Container for a set of metafields (maximum of 20 characters).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "Identifier for the metafield (maximum of 30 characters).",
"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": "metafields",
"description": "A paginated list of metafields associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Finds all metafields with a specific namespace under the resource.",
"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": "name",
"description": "Unique identifier for the order that appears on the order.\nFor example, _#1000_ or _Store1001.\nThis value is not unique across multiple stores.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "netPayment",
"description": "Net payment for the order, based on the total amount received - total amount refunded.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `netPaymentSet` instead"
},
{
"name": "netPaymentSet",
"description": "Net payment for the order, based on the total amount received - total amount refunded in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "nonFulfillableLineItems",
"description": "Line items that can't be fulfilled.\nFor example, because some or all of the items have been refunded, or the item is not one which can be fulfilled, such as a tip.\nThese line items would be 'lost' if you only considered the line items in draft fulfillments or fulfillments.\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": "LineItemConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "Contents of the note associated with the order.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentGatewayNames",
"description": "List of all payment gateways used for the order.\nFor example, _authorize_net_ and _Cash on Delivery (COD)_.\n",
"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": "phone",
"description": "Phone number provided by the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "physicalLocation",
"description": "If the order was processed using Shopify POS, then this is its location as provided by the merchant.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "presentmentCurrencyCode",
"description": "The payment currency of the customer for this order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CurrencyCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "Returns a private metafield found by namespace and key.",
"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.",
"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": "processedAt",
"description": "Date and time when the order was processed.\nWhen orders are imported from an app, this date and time may not match the date and time when the order was created.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publication",
"description": "Publication that created the order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Publication",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "referralCode",
"description": "Marketing referral code from the link that the customer clicked to visit your store.\nSupports the following URL attributes: _ref_, _source_, or _r_. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `customerJourney.lastVisit.referralCode` instead"
},
{
"name": "referrerDisplayText",
"description": "Website that sent the customer to your online store.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `customerJourney.lastVisit.referralInfoHtml` instead"
},
{
"name": "referrerUrl",
"description": "Webpage where the customer clicked a link that sent them to your online store.\nFor example, _Google_ or _randomblog.com/page1_.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `customerJourney.lastVisit.referrerUrl` instead"
},
{
"name": "refundable",
"description": "Whether the order can be refunded.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refunds",
"description": "List of refunds that have been applied to the order.\n",
"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": "Refund",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiresShipping",
"description": "Whether any line item in the order requires physical shipping.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restockable",
"description": "Whether the order can be restocked.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "riskLevel",
"description": "Fraud risk level of the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderRiskLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "risks",
"description": "The order risks associated with this order.",
"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": "OrderRisk",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "Mailing address for shipping provided by the customer.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MailingAddress",
"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": "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": "subtotalPrice",
"description": "Subtotal of the line items and their discounts (does not contain shipping costs, shipping discounts, and order-level discounts).\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `subtotalPriceSet` instead"
},
{
"name": "subtotalPriceSet",
"description": "Subtotal of the line items and their discounts (does not contain shipping costs, shipping discounts, and order-level discounts) in shop and presentment currencies.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "suggestedRefund",
"description": "The details of the suggested refund. This response can be used to submit a RefundCreate mutation.",
"args": [
{
"name": "shippingAmount",
"description": "The amount to refund for shipping. Overrides `refundShipping`.",
"type": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
},
"defaultValue": null
},
{
"name": "refundShipping",
"description": "Whether to refund the full shipping amount.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "refundLineItems",
"description": "The line items from the order to include in the refund.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "RefundLineItemInput",
"ofType": null
}
}
},
"defaultValue": null
},
{
"name": "suggestFullRefund",
"description": "Whether a refund for all of the refundable line items on an order should be suggested.\nIf `true`, the suggested refund will be formed from all refundable line items and will\nignore any passed in `refundLineItems`.\n",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
}
],
"type": {
"kind": "OBJECT",
"name": "SuggestedRefund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tags",
"description": "List of tags.",
"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": "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": "taxesIncluded",
"description": "Whether taxes are included in the subtotal price of the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "test",
"description": "Whether the order is a test.\nTest orders are made using the Shopify Bogus Gateway or the Shopify Payments test mode.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCapturable",
"description": "Amount authorized for the order, that is uncaptured or undercaptured.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `totalCapturableSet` instead"
},
{
"name": "totalCapturableSet",
"description": "Amount authorized for the order, that is uncaptured or undercaptured in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalDiscounts",
"description": "Total amount discounted from the order (includes order-level and line item discounts).",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `totalDiscountsSet` instead"
},
{
"name": "totalDiscountsSet",
"description": "Total amount discounted from the order (includes order-level and line item discounts) in shop and presentment currencies.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPrice",
"description": "Total amount of the order (includes taxes and discounts).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `totalPriceSet` instead"
},
{
"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
},
{
"name": "totalReceived",
"description": "Total amount received by the customer for the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `totalReceivedSet` instead"
},
{
"name": "totalReceivedSet",
"description": "Total amount received by the customer for the order in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalRefunded",
"description": "Total amount refunded for the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `totalRefundedSet` instead"
},
{
"name": "totalRefundedSet",
"description": "Total amount refunded for the order in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalRefundedShippingSet",
"description": "Total amount refunded for shipping in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalShippingPrice",
"description": "Total amount charged for shipping the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `totalShippingPriceSet` instead"
},
{
"name": "totalShippingPriceSet",
"description": "Total amount charged for shipping the order in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalTax",
"description": "Total of all taxes applied to the order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `totalTaxSet` instead"
},
{
"name": "totalTaxSet",
"description": "Total of all taxes applied to the order in shop and presentment currencies.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalWeight",
"description": "Total weight (grams) of the order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactions",
"description": "List of all transactions associated with the order.",
"args": [
{
"name": "first",
"description": "Truncate the array result to this size.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "capturable",
"description": "Filter transactions by whether they are capturable.\nIf true, then returns only transactions that represent an authorized payment that can be captured.\nIf false, then returns all transactions.\n",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null
},
{
"name": "manuallyResolvable",
"description": "Filter transactions by whether they are manual payments.\nIf true, then returns only transactions that are manual payments. If false, then returns all transactions.\n",
"type": {
"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": "OrderTransaction",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unpaid",
"description": "Whether no payments have been made for the order.\nIf no payments have been made for the order, then this returns true.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Date and time when the order was last modified.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "CommentEventSubject",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasMetafields",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasEvents",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": 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": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": 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": "PriceRule",
"ofType": null
}
]
},
{
"kind": "INTERFACE",
"name": "HasMetafields",
"description": "Represents information about the metafields associated to the specified resource.",
"fields": [
{
"name": "metafield",
"description": "The metafield associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Container for a set of metafields (maximum of 20 characters).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "Identifier for the metafield (maximum of 30 characters).",
"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": "metafields",
"description": "A paginated list of metafields associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Finds all metafields with a specific namespace under the resource.",
"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 found by namespace and key.",
"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.",
"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
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrder",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "Metafield",
"description": "Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are\ncomprised of keys, values, and value types.\n",
"fields": [
{
"name": "description",
"description": "The description of a metafield.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "key",
"description": "The key name for a metafield.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"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": "namespace",
"description": "The namespace for a metafield.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ownerType",
"description": "Owner type of a metafield visible to the Storefront API.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MetafieldOwnerType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of a metafield.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueType",
"description": "Represents the metafield value type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MetafieldValueType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"description": "Interoperability metadata for types that directly correspond to a REST Admin API resource.\nFor example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://help.shopify.com/api/reference/products/product) in the REST Admin API.\n",
"fields": [
{
"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
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrder",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
{
"kind": "OBJECT",
"name": "InventoryItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Location",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MarketingEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Metafield",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MetafieldStorefrontVisibility",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PriceRule",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Refund",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SavedSearch",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ScriptTag",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopifyPaymentsDispute",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopifyPaymentsPayout",
"ofType": null
},
{
"kind": "OBJECT",
"name": "WebhookSubscription",
"ofType": null
}
]
},
{
"kind": "SCALAR",
"name": "UnsignedInt64",
"description": "An unsigned 64-bit integer. Represents whole numeric values between 0 and 2^64 - 1 encoded as a string of base-10 digits.\n\nExample value: `\"50\"`.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MetafieldValueType",
"description": "Metafield value types.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "STRING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INTEGER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JSON_STRING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MetafieldOwnerType",
"description": "Metafield owner types.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ARTICLE",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BLOG",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFTORDER",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCTIMAGE",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCTVARIANT",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHOP",
"description": "A metafield owner type.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MetafieldConnection",
"description": null,
"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": "MetafieldEdge",
"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": "PageInfo",
"description": "Information about pagination in a connection.",
"fields": [
{
"name": "hasNextPage",
"description": "Indicates if there are more pages to fetch.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasPreviousPage",
"description": "Indicates if there are any pages prior to the current page.",
"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": "MetafieldEdge",
"description": null,
"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 MetafieldEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Metafield",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Int",
"description": "Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PrivateMetafield",
"description": "Private metafields represent custom metadata that is attached to a resource.\nPrivate metafields are private to the application that creates them on a shop's resources.\n",
"fields": [
{
"name": "id",
"description": "The id of the private metafield.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "key",
"description": "The key name for a private metafield.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "namespace",
"description": "The namespace for a private metafield.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value of a private metafield.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueType",
"description": "Represents the private metafield value type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PrivateMetafieldValueType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PrivateMetafieldValueType",
"description": "Private Metafield value types.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "STRING",
"description": "A private metafield value type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INTEGER",
"description": "A private metafield value type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JSON_STRING",
"description": "A private metafield value type.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PrivateMetafieldConnection",
"description": null,
"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": "PrivateMetafieldEdge",
"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": "PrivateMetafieldEdge",
"description": null,
"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 PrivateMetafieldEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PrivateMetafield",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "HasEvents",
"description": "Connector to event records on a compatible host.",
"fields": [
{
"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://help.shopify.com/api/getting-started/search-syntax).\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
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Customer",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticBxgy",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountAutomaticNode",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DiscountCodeNode",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrder",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PriceRule",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "EventConnection",
"description": null,
"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": "EventEdge",
"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": "EventEdge",
"description": null,
"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 EventEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Event",
"description": "Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the\naddition of a product.\n",
"fields": [
{
"name": "appTitle",
"description": "The name of the app that created the event. Returns null when the event originates from the Shopify admin.",
"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": "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": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "BasicEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CommentEvent",
"ofType": null
}
]
},
{
"kind": "SCALAR",
"name": "FormattedString",
"description": "A string containing a strict subset of HTML code. Non-allowed tags will be stripped out.\nAllowed tags:\n* `a` (allowed attributes: `href`)\n* `b`\n* `br`\n* `em`\n* `i`\n* `strong`\n* `u`\n\nExample value: `\"Your current domain is <strong>johns-apparel.myshopify.com</strong>.\"`\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "DateTime",
"description": "An ISO-8601 encoded UTC date time string. Example value: `\"2019-07-03T20:47:55Z\"`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "EventSortKeys",
"description": "The set of valid sort keys for the events 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": "ResourceAlert",
"description": "Presents information or problems to merchants, with 1 or more actions that they can take.\nThey can optionally have a specific icon and be dismissed by merchants.\n",
"fields": [
{
"name": "actions",
"description": "Buttons in the alert that link to related information.\nFor example, _View risk assessment_.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ResourceAlertAction",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "content",
"description": "Details about the alert.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "HTML",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dismissibleHandle",
"description": "Unique identifier that appears when an alert is manually closed by the merchant.\nMost alerts cannot be manually closed.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "icon",
"description": "Icon that displays with the alert.",
"args": [],
"type": {
"kind": "ENUM",
"name": "ResourceAlertIcon",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "severity",
"description": "Indication of how important the alert is.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ResourceAlertSeverity",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The name of the alert.",
"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": "ResourceAlertAction",
"description": "An action associated to a resource alert.",
"fields": [
{
"name": "primary",
"description": "Whether the action is primary or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "show",
"description": "Resource for the action to show.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "Action title.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "Action target URL.",
"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": "SCALAR",
"name": "URL",
"description": "An RFC 3986 and RFC 3987 compliant URI string.\n\nExample value: `\"https://johns-apparel.myshopify.com\"`.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "HTML",
"description": "A string containing HTML code. Example value: `\"<p>Grey cotton knit sweater.</p>\"`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ResourceAlertIcon",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CHECKMARK_CIRCLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INFORMATION_CIRCLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ResourceAlertSeverity",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DEFAULT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INFO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WARNING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CRITICAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ERROR",
"description": null,
"isDeprecated": true,
"deprecationReason": "`ERROR` severity is being deprecated in favour of `WARNING` or `CRITICAL` instead"
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MailingAddress",
"description": "Represents a customer mailing address.\n\nFor example, a customer's default address and an order's billing address are both mailling addresses.\n",
"fields": [
{
"name": "address1",
"description": "The first line of the address. Typically the street address or PO Box number.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "address2",
"description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "city",
"description": "The name of the city, district, village, or town.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "company",
"description": "The name of the customer's company or organization.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "The name of the country.\n",
"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.\n\nFor example, US.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `countryCodeV2` instead"
},
{
"name": "countryCodeV2",
"description": "The two-letter code for the country of the address.\n\nFor example, US.\n",
"args": [],
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "The first name of the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "formatted",
"description": "A formatted version of the address, customized by the provided arguments.",
"args": [
{
"name": "withName",
"description": "Whether to include the customer's name in the formatted address.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false"
},
{
"name": "withCompany",
"description": "Whether to include the customer's company in the formatted address.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true"
}
],
"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": "formattedArea",
"description": "A comma-separated list of the values for city, province, and country.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "The last name of the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "latitude",
"description": "The latitude coordinate of the customer address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "longitude",
"description": "The longitude coordinate of the customer address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The full name of the customer, based on firstName and lastName.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "phone",
"description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n",
"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.\n\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": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Float",
"description": "Represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).",
"fields": null,
"inputFields": null,
"interfaces": null,
"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": "Aland 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 And 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": "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 And 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.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CD",
"description": "Congo, The Democratic Republic Of The.",
"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": "Czech Republic.",
"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 (Malvinas).",
"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 Island And Mcdonald Islands.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VA",
"description": "Holy See (Vatican City State).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HN",
"description": "Honduras.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HK",
"description": "Hong Kong.",
"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, Islamic Republic Of.",
"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": "Korea, Democratic People's Republic Of.",
"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": "Lao People's Democratic Republic.",
"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": "Libyan Arab Jamahiriya.",
"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.",
"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, Republic of.",
"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.",
"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 Territory, Occupied.",
"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.",
"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": "Republic of Cameroon.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RE",
"description": "Reunion.",
"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": "Saint Barthélemy.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SH",
"description": "Saint Helena.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KN",
"description": "Saint Kitts And Nevis.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LC",
"description": "Saint Lucia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MF",
"description": "Saint Martin.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PM",
"description": "Saint Pierre And 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": "Sao Tome And Principe.",
"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 And The 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.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD",
"description": "Sudan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR",
"description": "Suriname.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SJ",
"description": "Svalbard And 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, United Republic Of.",
"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 and Tobago.",
"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 and 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": "United States Minor 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": "Virgin Islands, British.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WF",
"description": "Wallis And 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
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderCancelReason",
"description": "Represents the reason that the order is being canceled. Valid values are: customer, fraud, inventory, declined, other.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CUSTOMER",
"description": "The customer wanted to cancel the order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FRAUD",
"description": "The order was fraudulent.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVENTORY",
"description": "There was insufficient inventory.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DECLINED",
"description": "Payment was declined.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OTHER",
"description": "Some other reason not listed.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Money",
"description": "A monetary value string. Example value: `\"100.57\"`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MoneyBag",
"description": "A collection of monetary values in their respective currencies.\n",
"fields": [
{
"name": "presentmentMoney",
"description": "Amount in presentment currency.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopMoney",
"description": "Amount in shop currency.",
"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": "OBJECT",
"name": "MoneyV2",
"description": "A monetary value with currency.\n\nTo format currencies, combine this type's amount and currencyCode fields with your client's locale.\n\nFor example, in JavaScript you could use Intl.NumberFormat:\n\n```js\nnew Intl.NumberFormat(locale, {\n style: 'currency',\n currency: currencyCode\n}).format(amount);\n```\n\nOther formatting libraries include:\n\n* iOS - [NumberFormatter](https://developer.apple.com/documentation/foundation/numberformatter)\n* Android - [NumberFormat](https://developer.android.com/reference/java/text/NumberFormat.html)\n* PHP - [NumberFormatter](http://php.net/manual/en/class.numberformatter.php)\n\nFor a more general solution, the [Unicode CLDR number formatting database] is available with many implementations\n(such as [TwitterCldr](https://github.com/twitter/twitter-cldr-rb)).\n",
"fields": [
{
"name": "amount",
"description": "Decimal money amount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currencyCode",
"description": "Currency of the money.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CurrencyCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Decimal",
"description": "A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: `\"29.99\"`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CurrencyCode",
"description": "Currency codes",
"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": "BYR",
"description": "Belarusian Ruble (BYR).",
"isDeprecated": true,
"deprecationReason": "`BYR` is deprecated. Use `BYN` available from version `2019-10` onwards instead."
},
{
"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": "DJF",
"description": "Djiboutian Franc (DJF).",
"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": "GNF",
"description": "Guinean Franc (GNF).",
"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": "IRR",
"description": "Iranian Rial (IRR).",
"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": "LYD",
"description": "Libyan Dinar (LYD).",
"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": "SLL",
"description": "Sierra Leonean Leone (SLL).",
"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": "TJS",
"description": "Tajikistani Somoni (TJS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TZS",
"description": "Tanzanian Shilling (TZS).",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOP",
"description": "Tongan Pa'anga (TOP).",
"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": "VEF",
"description": "Venezuelan Bolivares (VEF).",
"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
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Channel",
"description": "A channel is a group of products and collections that is published to an app. A channel can be a platform or marketplace such\nas 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": "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.navigation_items instead"
},
{
"name": "overviewPath",
"description": "Home page for the channel.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use App.launch_url instead"
},
{
"name": "productPublications",
"description": null,
"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": "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": "App's developer name.",
"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": "List of app features.",
"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": "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": "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.",
"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.\n\nFor example, _By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time._\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": "Image",
"description": "Represents an image resource.",
"fields": [
{
"name": "altText",
"description": "A word or phrase to share the nature or contents of an image.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "A unique identifier for the image.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "The metafield associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Container for a set of metafields (maximum of 20 characters).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "Identifier for the metafield (maximum of 30 characters).",
"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": "metafields",
"description": "A paginated list of metafields associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Finds all metafields with a specific namespace under the resource.",
"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": "originalSrc",
"description": "The location of the original image as a URL.\n\nIf there are any existing transformations in the original source URL, they will remain and not be stripped.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "Returns a private metafield found by namespace and key.",
"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.",
"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": "src",
"description": "The location of the image as a URL.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Previously an image had a single `src` field. This could either return the original image\nlocation or a URL that contained transformations such as sizing or scale.\n\nThese transformations were specified by arguments on the parent field.\n\nNow an image has two distinct URL fields: `originalSrc` and `transformedSrc`.\n\n* `originalSrc` - the original unmodified image URL\n* `transformedSrc` - the image URL with the specified transformations included\n\nTo migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`.\n\nBefore:\n```graphql\n{\n shop {\n productImages(maxWidth: 200, scale: 2) {\n edges {\n node {\n src\n }\n }\n }\n }\n}\n```\n\nAfter:\n```graphql\n{\n shop {\n productImages {\n edges {\n node {\n transformedSrc(maxWidth: 200, scale: 2)\n }\n }\n }\n }\n}\n```\n"
},
{
"name": "transformedSrc",
"description": "The location of the transformed image as a URL.\n\nAll transformation arguments are considered \"best-effort\". If they can be applied to an image, they will be.\nOtherwise any transformations which an image type does not support will be ignored.\n",
"args": [
{
"name": "maxWidth",
"description": "Image width in pixels between 1 and 5760.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "maxHeight",
"description": "Image height in pixels between 1 and 5760.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"name": "crop",
"description": "Crops the image according to the specified region.",
"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.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": "1"
},
{
"name": "preferredContentType",
"description": "Best effort conversion of image into content type (SVG -> PNG, Anything -> JGP, Anything -> WEBP are supported).",
"type": {
"kind": "ENUM",
"name": "ImageContentType",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "HasMetafields",
"ofType": 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": "ImageContentType",
"description": "List of supported image content types.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PNG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JPG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WEBP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "NavigationItem",
"description": "A navigation item, holding basic link attributes.",
"fields": [
{
"name": "id",
"description": "The unique identifier of the navigation item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The name of the navigation item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL of the page that the navigation item links to.",
"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": "OBJECT",
"name": "FailedRequirement",
"description": "Requirements that must be met before an app can be installed.",
"fields": [
{
"name": "action",
"description": "Action to be taken to resolve a failed requirement, including URL link.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "NavigationItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app\nencounters when trying to make use of their Shop and its resources.\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": "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": "UserError",
"description": "Represents an error in the input of a mutation.",
"fields": [
{
"name": "field",
"description": "Path to the input field which 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": "INTERFACE",
"name": "DisplayableError",
"description": "Represents an error in the input of a mutation.",
"fields": [
{
"name": "field",
"description": "Path to the input field which 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": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "DiscountUserError",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PriceRuleUserError",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TranslationUserError",
"ofType": null
},
{
"kind": "OBJECT",
"name": "UserError",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "Link",
"description": "A link to direct users to.",
"fields": [
{
"name": "label",
"description": "A context-sensitive label for the link.",
"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": "url",
"description": "The URL that the link visits.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "HasPublishedTranslations",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "HasPublishedTranslations",
"description": "Published translations associated with the resource.",
"fields": [
{
"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
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Link",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OnlineStoreArticle",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OnlineStoreBlog",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OnlineStorePage",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductOption",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "PublishedTranslation",
"description": "Published translation of a field of a resource.",
"fields": [
{
"name": "key",
"description": "Translation key.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locale",
"description": "Translation locale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Translation value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"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": "Access scopes granted to an app 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": "Active subscriptions charged 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": 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": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "launchUrl",
"description": "Url used to launch the app.",
"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": "Publication associated with the installed application.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Publication",
"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": "Webpage where you can uninstall the app.",
"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": "AccessScope",
"description": "Represents the access scope permission that is applicable to a merchant's shop, such as `read_orders`.\n",
"fields": [
{
"name": "description",
"description": "Description of the access scopes enabled on an api permission.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "handle",
"description": "A human-friendly string for an access scope.",
"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": "Publication",
"description": "A publication is a group of products and collections that is published to an app. A publication can be a platform or marketplace such\nas Facebook or Pinterest, an online store, or POS.\n",
"fields": [
{
"name": "app",
"description": "The app associated with the publication.",
"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 publication.",
"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 publication.",
"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": "hasCollection",
"description": "Whether the collection is available to the publication.",
"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": "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 publication.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productPublicationsV3",
"description": "The product publications for the list of products published to the publication.",
"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 publication.",
"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 publication 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": "ResourcePublicationConnection",
"description": null,
"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": "ResourcePublicationEdge",
"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": "ResourcePublicationEdge",
"description": null,
"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 ResourcePublicationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ResourcePublication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ResourcePublication",
"description": "A resource publication represents that a resource has been published to a publication.",
"fields": [
{
"name": "channel",
"description": "The channel the resource publication is published to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `publication` instead"
},
{
"name": "isPublished",
"description": "Whether the resource 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 the resource publication is published to.",
"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 resource publication was or is going to be published to the publication.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishable",
"description": "The resource published to the publication.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INTERFACE",
"name": "Publishable",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Publishable",
"description": "Represents a resource that can be published to a channel.\nA publishable resource can be either a Product or Collection.\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": "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": "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": "Return only the resources that are published. If false, then return all resource publications.",
"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": "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
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "ChannelConnection",
"description": null,
"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": null,
"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": "OBJECT",
"name": "PublicationConnection",
"description": null,
"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": "PublicationEdge",
"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": "PublicationEdge",
"description": null,
"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 PublicationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Publication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionConnection",
"description": null,
"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": "CollectionEdge",
"description": null,
"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": "OBJECT",
"name": "Collection",
"description": "Represents a collection of products.\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": "The stripped description of the collection, in a single line with HTML tags removed.",
"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, complete with HTML formatting.",
"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 human-friendly string for the collection. Automatically generated from the collection's title.\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 a 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": "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": "metafield",
"description": "The metafield associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Container for a set of metafields (maximum of 20 characters).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "Identifier for the metafield (maximum of 30 characters).",
"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": "metafields",
"description": "A paginated list of metafields associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Finds all metafields with a specific namespace under the resource.",
"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 found by namespace and key.",
"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.",
"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"
},
{
"name": "query",
"description": "This field is only used when the collection is smart. If the collection is custom it returns an error.\nSupported filter parameters:\n - `title`\n - `product_type`\n - `vendor`\n - `gift_card`\n - `created_at`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productsCount",
"description": "The number of products included 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": "Return only the resources that are published. If false, then return all resource publications.",
"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": "ruleSet",
"description": "The rules used to assign products to the collection. This applies only to smart collections.\n",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CollectionRuleSet",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "SEO information for the collection.",
"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 collection's products are sorted.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionSortOrder",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storefrontId",
"description": "The storefront ID of the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "StorefrontID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "templateSuffix",
"description": "The theme template used when viewing this collection in a store.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the collection.",
"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": "HasMetafields",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Publishable",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasPublishedTranslations",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "StorefrontID",
"description": "Represents a unique identifier in the Storefront API. A `StorefrontID` value can be used wherever an ID is expected in the Storefront API.\n\nExample value: `\"Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzEwMDc5Nzg1MTAw\"`.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SEO",
"description": "SEO information.",
"fields": [
{
"name": "description",
"description": "SEO Description.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "SEO Title.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": 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": "MANUAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BEST_SELLING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ALPHA_ASC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ALPHA_DESC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRICE_DESC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRICE_ASC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED_DESC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ResourceFeedback",
"description": null,
"fields": [
{
"name": "appFeedback",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppFeedback",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "Use `details` instead"
},
{
"name": "details",
"description": "List of AppFeedback detailing issues regarding a resource.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppFeedback",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "summary",
"description": "Summary of resource feedback pertaining to the resource.",
"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": "ProductConnection",
"description": null,
"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": "ProductEdge",
"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": "ProductEdge",
"description": null,
"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 ProductEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Product",
"description": "Represents a product, including information about related collections and product variants.",
"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": "bodyHtml",
"description": "The description of the product, complete with HTML formatting.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `descriptionHtml` instead"
},
{
"name": "collections",
"description": "A list of the collections that include the product.",
"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": "CollectionSortKeys",
"ofType": null
},
"defaultValue": "ID"
},
{
"name": "query",
"description": "Supported filter parameters:\n - `collection_type`\n - `published_status`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultCursor",
"description": "A default cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "A stripped description of the product, single line with HTML tags removed.",
"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 product, complete with HTML formatting.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "HTML",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionPlainSummary",
"description": "Stripped description of the product, single line with HTML tags removed.\nTruncated to 60 characters.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `description` instead"
},
{
"name": "featuredImage",
"description": "The featured image for the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "feedback",
"description": "Information about the product that's provided through resource feedback.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ResourceFeedback",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardTemplateSuffix",
"description": "The theme template used when viewing the gift card in a store.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "handle",
"description": "A unique human-friendly string of the product's title.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasOnlyDefaultVariant",
"description": "Whether the product has only a single variant with the default option and value.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasOutOfStockVariants",
"description": "Whether the product has out of stock variants.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "images",
"description": "The images associated with the product.",
"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": "ProductImageSortKeys",
"ofType": null
},
"defaultValue": "POSITION"
},
{
"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": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ImageConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inCollection",
"description": "Whether the product is in a given collection.",
"args": [
{
"name": "id",
"description": "The ID of the collection 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": "isGiftCard",
"description": "Whether the product is a gift card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"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": "The metafield associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Container for a set of metafields (maximum of 20 characters).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "Identifier for the metafield (maximum of 30 characters).",
"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": "metafields",
"description": "A paginated list of metafields associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Finds all metafields with a specific namespace under the resource.",
"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": "onlineStorePreviewUrl",
"description": "The online store preview URL.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "onlineStoreUrl",
"description": "The online store URL for the product.\nA value of `null` indicates that the product is not published to the Online Store sales channel.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "options",
"description": "A list of custom product options (maximum of 3 per product).",
"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": "ProductOption",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceRange",
"description": "The price range of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductPriceRange",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "Returns a private metafield found by namespace and key.",
"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.",
"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": "productPublications",
"description": "A list of the channels where the product is published.",
"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 `resourcePublications` instead"
},
{
"name": "productType",
"description": "The product type specified by the merchant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"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": "A list of the channels where the product is published.",
"args": [
{
"name": "onlyPublished",
"description": "Return only the publications that are published. If false, then return all publications.",
"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": "ProductPublicationConnection",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `resourcePublications` instead"
},
{
"name": "publishedAt",
"description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was published to the Online Store.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"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": "Return only the resources that are published. If false, then return all resource publications.",
"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": "seo",
"description": "SEO information of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SEO",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storefrontId",
"description": "The storefront ID of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "StorefrontID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tags",
"description": "A list of the tags that have been added to the product.",
"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": "templateSuffix",
"description": "The theme template used when viewing the product in a store.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"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": "totalInventory",
"description": "The quantity of inventory in stock.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalVariants",
"description": "The number of variants that are associated with the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tracksInventory",
"description": "Whether inventory tracking has been enabled for the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"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 product was last modified.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "A list of variants associated with the product.",
"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": "ProductVariantSortKeys",
"ofType": null
},
"defaultValue": "POSITION"
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "vendor",
"description": "The name of the product's vendor.",
"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
},
{
"kind": "INTERFACE",
"name": "Navigable",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasMetafields",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasPublishedTranslations",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Publishable",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "OnlineStorePreviewable",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Navigable",
"description": "A default cursor for use in pagination.\nThe default cursor can be used for next and previous navigation.\n",
"fields": [
{
"name": "defaultCursor",
"description": "A default cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "OnlineStoreArticle",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OnlineStorePage",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
]
},
{
"kind": "INTERFACE",
"name": "OnlineStorePreviewable",
"description": "Online Store preview URL of the object.",
"fields": [
{
"name": "onlineStorePreviewUrl",
"description": "The online store preview URL.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "ProductPriceRange",
"description": "The price range of the product.",
"fields": [
{
"name": "maxVariantPrice",
"description": "The highest variant's price.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minVariantPrice",
"description": "The lowest variant's price.",
"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": "OBJECT",
"name": "ImageConnection",
"description": null,
"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": "ImageEdge",
"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": "ImageEdge",
"description": null,
"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 ImageEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductImageSortKeys",
"description": "The set of valid sort keys for the images query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "POSITION",
"description": "Sort by the `position` 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": "ProductPublicationConnection",
"description": null,
"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": "ProductPublicationEdge",
"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": "ProductPublicationEdge",
"description": null,
"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 ProductPublicationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductPublication",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductPublication",
"description": "Represents the channels where a product is published.",
"fields": [
{
"name": "channel",
"description": "The channel where the product was or is published.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"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": "product",
"description": "The product that was or is going to be published on the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishDate",
"description": "The date that the product was or is going to be published on the channel.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionSortKeys",
"description": "The set of valid sort keys for the collections 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": "OBJECT",
"name": "ProductOption",
"description": "Custom product property names like \"Size\", \"Color\", and \"Material\".\nProducts are based on permutations of these options.\nA product may have a maximum of 3 options.\n255 characters limit each.\n",
"fields": [
{
"name": "id",
"description": "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 product optionΓÇÖs name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "position",
"description": "The product option's position.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"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": "values",
"description": "The corresponding value to the product option name.",
"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
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasPublishedTranslations",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantConnection",
"description": null,
"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": "ProductVariantEdge",
"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": "ProductVariantEdge",
"description": null,
"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 ProductVariantEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"description": "Represents a product variant.",
"fields": [
{
"name": "availableForSale",
"description": "Whether the product variant is available for sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "barcode",
"description": "The value of the barcode associated with the product.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "compareAtPrice",
"description": "The compare-at price of the variant in the default shop currency.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the variant was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultCursor",
"description": "A default cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deliveryProfile",
"description": "The delivery profile for the variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DeliveryProfile",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayName",
"description": "Display name of the variant, based on product's title + variant's title.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentService",
"description": "The fulfillment service associated with the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "FulfillmentService",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentServiceEditable",
"description": "Whether changes to the fulfillment service for the product variant are allowed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EditableProperty",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "harmonizedSystemCode",
"description": "The Harmonized System Code (or HS Tariff Code) for the variant.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "Use `InventoryItem.harmonized_system_code` instead."
},
{
"name": "id",
"description": "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 featured image for the variant.",
"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": "images",
"description": "The featured image for the variant.",
"args": [
{
"name": "first",
"description": "Truncate the array result to this size.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null
},
{
"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": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "Use the singular `image` field instead. There may never be more than one variant image."
},
{
"name": "inventoryItem",
"description": "The ID for the inventory item, which is used to query for inventory information.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InventoryItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryManagement",
"description": "The fulfillment service that tracks the number of items in stock for the product variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductVariantInventoryManagement",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use tracked attribute on `inventoryItem` instead."
},
{
"name": "inventoryPolicy",
"description": "Whether customers are allowed to place an order for the product variant when it's out of stock.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductVariantInventoryPolicy",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryQuantity",
"description": "The total sellable quantity of the variant.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"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": "The metafield associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Container for a set of metafields (maximum of 20 characters).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "Identifier for the metafield (maximum of 30 characters).",
"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": "metafields",
"description": "A paginated list of metafields associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Finds all metafields with a specific namespace under the resource.",
"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": "position",
"description": "The order of the product variant in the list of product variants. The first position in the list is 1.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "presentmentPrices",
"description": "List of prices and compare-at prices in the presentment currencies for this shop.",
"args": [
{
"name": "presentmentCurrencies",
"description": "The presentment currencies prices should return in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CurrencyCode",
"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": "ProductVariantPricePairConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The price of the product variant in the default shop currency.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "Returns a private metafield found by namespace and key.",
"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.",
"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": "product",
"description": "The product that this variant belongs to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiresShipping",
"description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `InventoryItem.requires_shipping` instead."
},
{
"name": "selectedOptions",
"description": "List of product options applied to the variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SelectedOption",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storefrontId",
"description": "The storefront ID of the product variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "StorefrontID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCode",
"description": "The tax code for the product variant.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxable",
"description": "Whether a tax is charged when the product variant is sold.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "The title of the product variant.",
"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": "updatedAt",
"description": "The date and time (ISO 8601 format) when the product variant was last modified.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "The weight of the product variant in the unit system specified with weight_unit.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weightUnit",
"description": "The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: `g`, `kg`, `oz`, `lb`.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WeightUnit",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasMetafields",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasPublishedTranslations",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Navigable",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentService",
"description": "Represents a fulfillment service. A fulfillment service is a third-party service that prepares and ships orders on behalf of the store owner.\n",
"fields": [
{
"name": "handle",
"description": "Human-readable unique identifier for this fulfillment service.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the fulfillment service.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryManagement",
"description": "Whether the fulfillment service tracks product inventory and provides updates to Shopify.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "location",
"description": "Location associated with the fulfillment service.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productBased",
"description": "Whether the fulfillment service supports local deliveries.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "serviceName",
"description": "The name of the fulfillment service as seen by merchants.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethods",
"description": "Shipping methods associated with the fulfillment service provider.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Type associated with the fulfillment service.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "FulfillmentServiceType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "FulfillmentServiceType",
"description": "The type of a fulfillment service.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GIFT_CARD",
"description": "Fulfillment by gift card.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANUAL",
"description": "Manual fulfillment by the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "THIRD_PARTY",
"description": "Fullfillment by a third-party fulfillment service.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethod",
"description": "The shipping method for the delivery.",
"fields": [
{
"name": "code",
"description": "A unique code associated with the rate. For example: `expedited_mail`",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "label",
"description": "A description of the rate, which customers will see at checkout.\nFor example: `Includes tracking and insurance`.\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": "Location",
"description": "Represents the location where the physical good resides.\n",
"fields": [
{
"name": "activatable",
"description": "Whether this location can be reactivated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "address",
"description": "The LocationAddress object for location.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LocationAddress",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addressVerified",
"description": "Whether the location address has been verified.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deactivatable",
"description": "Whether this location can be deactivated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deactivatedAt",
"description": "Date and time the location was deactivated (null if location is still active). Following UTC ISO8601 format, e.g.: \"2019-04-24T13:42:24Z\".",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deletable",
"description": "Whether this location can be deleted.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentService",
"description": "Name of the service provider that fulfills from this location.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "FulfillmentService",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillsOnlineOrders",
"description": "Indicates whether this location can fulfill online orders.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasActiveInventory",
"description": "Indicates whether or not this location has active inventory.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasUnfulfilledOrders",
"description": "Indicates whether or not this location has unfulfilled orders.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryLevel",
"description": "A single inventory level for the given inventory item.",
"args": [
{
"name": "inventoryItemId",
"description": "Specifies the inventory item ID for the inventory level to be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "InventoryLevel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryLevels",
"description": "Paginated list of inventory levels for inventory items stocked at the location.",
"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 - `created_at`\n - `inventory_group_id`\n - `inventory_item_id`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InventoryLevelConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Whether the location is active.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPrimary",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location"
},
{
"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": "name",
"description": "The name of the location.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shipsInventory",
"description": "Indicates whether or not this location ships inventory.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "suggestedAddresses",
"description": "List of suggested addresses for this location (empty if none).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LocationSuggestedAddress",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "LocationAddress",
"description": "Represents the address of the location.\n",
"fields": [
{
"name": "address1",
"description": "The first line of the address for the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "address2",
"description": "The second line of the address for the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "city",
"description": "The city of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "The country of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "The two-letter country code of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "formatted",
"description": null,
"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": "latitude",
"description": "The latitude coordinates of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "longitude",
"description": "The longitude coordinates of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "phone",
"description": "The phone number of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "province",
"description": "The province of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "provinceCode",
"description": "The code for the region of the address, such as the province, state, or district.\nFor example QC for Quebec, Canada.\n",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "zip",
"description": "The ZIP code of the location.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "LocationSuggestedAddress",
"description": "Represents a suggested address for a location.\n",
"fields": [
{
"name": "address1",
"description": "The first line of the suggested address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "address2",
"description": "The second line of the suggested address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "city",
"description": "The city of the suggested address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "The country of the suggested address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "The country code of the suggested address.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "formatted",
"description": "A formatted version of the suggested address.",
"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": "province",
"description": "The province of the suggested address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "provinceCode",
"description": "The province code of the suggested address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "zip",
"description": "The ZIP code of the suggested address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InventoryLevelConnection",
"description": null,
"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": "InventoryLevelEdge",
"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": "InventoryLevelEdge",
"description": null,
"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 InventoryLevelEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InventoryLevel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InventoryLevel",
"description": "Represents the inventory quantity of an inventory item at a specific location.\n",
"fields": [
{
"name": "available",
"description": "Quantity of items available at the location.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canDeactivate",
"description": "Whether inventoryDeactivate is allowed for this inventory level.",
"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 inventory level was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deactivationAlert",
"description": "Reason why canDeactivate is false, or impact of deactivating the inventory level.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deactivationAlertHtml",
"description": "Reason why canDeactivate is false with URLs linked in HTML, or impact of deactivating the inventory level.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "FormattedString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "incoming",
"description": "Quantity of items incoming to the location.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "item",
"description": "Inventory item associated with the inventory level.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InventoryItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "location",
"description": "Location associated with the inventory level.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The date and time when the inventory level was updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InventoryItem",
"description": "Represents the goods available to be shipped to a customer.\nIt holds essential information about the goods, including SKU and whether it is tracked.\n",
"fields": [
{
"name": "countryCodeOfOrigin",
"description": "The ISO code of the country of origin.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryHarmonizedSystemCodes",
"description": "List of country specific harmonized system codes.",
"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": "CountryHarmonizedSystemCodeConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date and time when the inventory item was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "duplicateSkuCount",
"description": "The number of inventory items that share the same SKU with this item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "harmonizedSystemCode",
"description": "The harmonized system code of the item.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryHistoryUrl",
"description": "URL for inventory history web page.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryLevel",
"description": "Get the inventory level at a specific location.",
"args": [
{
"name": "locationId",
"description": "ID of the location for which the inventory level is requested.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "OBJECT",
"name": "InventoryLevel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inventoryLevels",
"description": "Paginated list of inventory levels for each location that the inventory item is stocked at.",
"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 - `created_at`\n - `inventory_group_id`\n - `inventory_item_id`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\n",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InventoryLevelConnection",
"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": "locationsCount",
"description": "The number of locations where this inventory item is stocked.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "provinceCodeOfOrigin",
"description": "The ISO code of the province of origin.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiresShipping",
"description": "Whether the item requires shipping or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "Inventory item SKU.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tracked",
"description": "Whether the inventory quantities of inventory levels for the item are tracked or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackedEditable",
"description": "Whether changes to the inventory item tracked attribute are allowed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EditableProperty",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitCost",
"description": "Unit cost associated with the inventory item.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The date and time when the inventory item was updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variant",
"description": "The variant that owns this inventory item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "EditableProperty",
"description": "The attribute editable information.",
"fields": [
{
"name": "locked",
"description": "Whether the attribute is locked for editing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "The reason the attribute is locked for editing.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "FormattedString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CountryHarmonizedSystemCodeConnection",
"description": null,
"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": null,
"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": "OBJECT",
"name": "CountryHarmonizedSystemCode",
"description": "Holds the country specific harmonized system code and the country ISO code.\n",
"fields": [
{
"name": "countryCode",
"description": "Country ISO code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "harmonizedSystemCode",
"description": "Country specific harmonized system code.",
"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": "ENUM",
"name": "PosLinkLayout",
"description": "Available layouts for a POS link.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MODAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULLSCREEN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductVariantInventoryManagement",
"description": "The method of inventory tracking for a product variant.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SHOPIFY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_MANAGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_SERVICE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductVariantInventoryPolicy",
"description": "The inventory policy for a product variant controls whether customers can continue to buy the variant when it\nis out of stock. When the value is <code>continue</code>, customers are able to buy the variant when it's out of stock.\nWhen the value is <code>deny</code>, customers can't buy the variant when it's out of stock.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DENY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONTINUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SelectedOption",
"description": "Custom properties that a shop owner can use to define product variants.\nMultiple options can exist. Options are represented as: option1, option2, option3, etc.\n",
"fields": [
{
"name": "name",
"description": "The product optionΓÇÖs name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The product optionΓÇÖs value.",
"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": "ProductVariantPricePairConnection",
"description": null,
"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": "ProductVariantPricePairEdge",
"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": "ProductVariantPricePairEdge",
"description": null,
"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 ProductVariantPricePairEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantPricePair",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantPricePair",
"description": "The compare-at price and price of a variant sharing a currency.\n",
"fields": [
{
"name": "compareAtPrice",
"description": "The compare-at price of the variant with associated currency.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The price of the variant with associated currency.",
"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": "ENUM",
"name": "WeightUnit",
"description": "Units of measurement for weight.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "KILOGRAMS",
"description": "1 kilogram equals 1000 grams.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAMS",
"description": "Metric system unit of mass.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "POUNDS",
"description": "1 pound equals 16 ounces.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUNCES",
"description": "Imperial system unit of mass.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryProfile",
"description": "A profile for multi-location, per-product delivery.",
"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": "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": "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": "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": "DeliveryProfileItemConnection",
"description": null,
"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": null,
"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": "DeliveryProfileItem",
"description": "A product and the subset of associated variants that are part of this delivery profile.",
"fields": [
{
"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": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductVariantSortKeys",
"description": "The set of valid sort keys for the variants query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "TITLE",
"description": "Sort by the `title` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort by the `name` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SKU",
"description": "Sort by the `sku` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVENTORY_QUANTITY",
"description": "Sort by the `inventory_quantity` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVENTORY_MANAGEMENT",
"description": "Sort by the `inventory_management` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVENTORY_LEVELS_AVAILABLE",
"description": "Sort by the `inventory_levels.available` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVENTORY_POLICY",
"description": "Sort by the `inventory_policy` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULL_TITLE",
"description": "Sort by the `full_title` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "POPULAR",
"description": "Sort by the `popular` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "POSITION",
"description": "Sort by the `position` 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": "ProfileItemSortKeys",
"description": "The set of valid sort keys for the profileItems query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "TITLE",
"description": "Sort by the `title` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_TYPE",
"description": "Sort by the `product_type` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VENDOR",
"description": "Sort by the `vendor` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVENTORY_TOTAL",
"description": "Sort by the `inventory_total` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATED_AT",
"description": "Sort by the `updated_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED_AT",
"description": "Sort by the `created_at` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLISHED_AT",
"description": "Sort by the `published_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": "DeliveryProfileLocationGroup",
"description": "Links a location group with zones associated to a delivery profile.",
"fields": [
{
"name": "countriesInAnyZone",
"description": "The countries already selected in any zone for the given location group and profile.",
"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 location group associated to a delivery profile.",
"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 a location group and 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": "DeliveryLocationGroupZoneConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryLocationGroup",
"description": "A location group is a collection of active locations that share zone and delivery methods across delivery profiles.",
"fields": [
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locations",
"description": "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://help.shopify.com/api/getting-started/search-syntax).\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": "LocationConnection",
"description": null,
"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": "LocationEdge",
"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": "LocationEdge",
"description": null,
"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 LocationEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Location",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "LocationSortKeys",
"description": "The set of valid sort keys for the locations 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": "DeliveryLocationGroupZoneConnection",
"description": null,
"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": null,
"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": "OBJECT",
"name": "DeliveryLocationGroupZone",
"description": "Links a location group and zone with the associated method definitions in a delivery profile.",
"fields": [
{
"name": "methodDefinitions",
"description": "The method definitions associated to a zone and location group in a delivery profile.",
"args": [
{
"name": "eligible",
"description": "Return only eligible or ineligible method definitions.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"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 in a delivery profile.",
"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": "DeliveryZone",
"description": "A zone is a geographical area that contains delivery methods within a delivery profile.",
"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": "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": "OBJECT",
"name": "DeliveryCountry",
"description": "A country that is used to define a zone.",
"fields": [
{
"name": "code",
"description": "The ISO 3166-1 alpha-2 country code of this country and a flag indicating Rest Of World.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DeliveryCountryCodeOrRestOfWorld",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "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 country.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "provinces",
"description": "The 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
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeliveryCountryCodeOrRestOfWorld",
"description": "The ISO 3166-1 alpha-2 country code and a flag indicating Rest Of World.",
"fields": [
{
"name": "countryCode",
"description": "The country code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restOfWorld",
"description": "Indicates if 'Rest of World' is applied.",
"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": "DeliveryProvince",
"description": "A region that is used to define a zone.",
"fields": [
{
"name": "code",
"description": "The code of this region.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "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 region.",
"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": "DeliveryMethodDefinitionConnection",
"description": null,
"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": "DeliveryMethodDefinitionEdge",
"description": null,
"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": "OBJECT",
"name": "DeliveryMethodDefinition",
"description": "A method definition describes the delivery rate and the conditions that must be met for the method to be applied.",
"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": "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": "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": "UNION",
"name": "DeliveryRateProvider",
"description": "Rate provided by a rate definition or a participant.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "DeliveryRateDefinition",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DeliveryParticipant",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "DeliveryRateDefinition",
"description": "The merchant-defined rate of the DeliveryMethodDefinition.",
"fields": [
{
"name": "id",
"description": "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": "OBJECT",
"name": "DeliveryParticipant",
"description": "A carrier-defined rate with possible merchant-defined fixed fee or percentage-of-rate fee.",
"fields": [
{
"name": "adaptToNewServicesFlag",
"description": "Flag to indicate if new available services should be included.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "carrierService",
"description": "Use this carrier service 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-set fixed fee for this participant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "participantServices",
"description": "Services offered by the participant and their active status.",
"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-set 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": "OBJECT",
"name": "DeliveryCarrierService",
"description": "Information about a carrier or service provider.",
"fields": [
{
"name": "availableServicesForCountries",
"description": "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": "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 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": "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 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": "DeliveryAvailableService",
"description": "The service and the countries they are 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": "DeliveryCountryCodesOrRestOfWorld",
"description": "A list of ISO 3166-1 alpha-2 country codes or the 'Rest of World'.",
"fields": [
{
"name": "countryCodes",
"description": "List of applicable country codes.",
"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": "Indicates if 'Rest of World' is applied.",
"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": "DeliveryParticipantService",
"description": "A service provided by a participant.",
"fields": [
{
"name": "active",
"description": "If the service is active or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "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": "DeliveryCondition",
"description": "A condition that must pass for a method definition to be applied to an order.",
"fields": [
{
"name": "conditionCriteria",
"description": "The criteria (weight or price) that the field must meet based on the operator.",
"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 criteria unit 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": "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 criteria.",
"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": "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 if the field is greater than or equal to the criteria.",
"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 criteria.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": 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": "Condition will check against the total weight of the order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOTAL_PRICE",
"description": "Condition will check against the total price of the order.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "UNION",
"name": "DeliveryConditionCriteria",
"description": "The criteria (weight or price) that the field must meet based on the operator.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "Weight",
"description": "Represents weight unit and value.",
"fields": [
{
"name": "unit",
"description": "Unit of measurement for `value`.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WeightUnit",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The weight using the unit system specified with `unit`.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MethodDefinitionSortKeys",
"description": "The set of valid sort keys for the methodDefinitions query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "RATE_PROVIDER_TYPE",
"description": "Sort by the `rate_provider_type` 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": "DeliveryCountryAndZone",
"description": "A country with the name of the zone.",
"fields": [
{
"name": "country",
"description": "The country in the delivery zone.",
"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 delivery 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": "ENUM",
"name": "ProductCollectionSortKeys",
"description": "The set of valid sort keys for the products query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "TITLE",
"description": "Sort by the `title` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRICE",
"description": "Sort by the `price` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BEST_SELLING",
"description": "Sort by the `best-selling` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED",
"description": "Sort by the `created` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": "Sort by the `id` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANUAL",
"description": "Sort by the `manual` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_DEFAULT",
"description": "Sort by the `collection-default` 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": "CollectionPublicationConnection",
"description": null,
"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": null,
"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": "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": "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": "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": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TITLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TYPE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VENDOR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_PRICE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_COMPARE_AT_PRICE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_WEIGHT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_INVENTORY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_TITLE",
"description": null,
"isDeprecated": false,
"deprecationReason": 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": "EQUALS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_EQUALS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GREATER_THAN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LESS_THAN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STARTS_WITH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENDS_WITH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONTAINS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_CONTAINS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "NavigationItemV2",
"description": "A navigation item, holding basic link attributes, extra configuration, and nested navigation items.",
"fields": [
{
"name": "children",
"description": "Sub-navigation items for this navigation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "NavigationItemV2",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "disabled",
"description": "Flag that indicates if the navigation is disabled or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "excludePaths",
"description": "Extra paths that should be used to not highlight the navigation as selected.",
"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": "hasStorefrontLink",
"description": "Flag indicating that the store front link must be shown within this navigation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "iconBody",
"description": "The SVG icon body to be displayed as the navigation's icon.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "label",
"description": "The navigation's label to be displayed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "matchExactPath",
"description": "Flag indicating that an exact match of the path is required to highlight the navigation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "matchPaths",
"description": "Extra paths that should be used to highlight the navigation as selected.",
"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": "url",
"description": "The URL that the navigation points to.",
"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": "ENUM",
"name": "NavigationItemV2Type",
"description": "Types for navigation item.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SALES_CHANNEL",
"description": "Navigation items for sales channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRIMARY_NAVIGATION",
"description": "Primary navigation items for apps.",
"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": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineItems",
"description": "Attaches a plan to an 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 where the merchant is redirected 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. Possible values include pending, active, declined,\n expired, frozen, and cancelled.",
"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 days of the free trial.",
"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": "AppSubscriptionLineItem",
"description": "Attaches a plan to an app subscription.",
"fields": [
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plan",
"description": "Defines 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": "Lists the store's usage 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": "OBJECT",
"name": "AppPlanV2",
"description": "Defines the app plan the merchant is subscribed to.",
"fields": [
{
"name": "pricingDetails",
"description": "Defines the pricing model for the app subscription.",
"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": "Information about the price charged to a shop every plan period.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AppUsagePricing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppRecurringPricing",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "AppUsagePricing",
"description": "Defines the usage pricing model for the app subscription.",
"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 limit a store can be charged for usage based pricing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "interval",
"description": "Specifies the interval which usage records are applied.",
"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.",
"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": "ENUM",
"name": "AppPricingInterval",
"description": "Interval for which pricing details are applied.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "EVERY_30_DAYS",
"description": "App plan pricing details are applied every 30 days.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRecurringPricing",
"description": "Price charged every interval.",
"fields": [
{
"name": "interval",
"description": "Specifies the number of days in a billing cycle of the 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 to be charged to the store 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": "OBJECT",
"name": "AppUsageRecordConnection",
"description": null,
"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": "AppUsageRecordEdge",
"description": null,
"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": "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": "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": "ENUM",
"name": "AppUsageRecordSortKeys",
"description": "The set of valid sort keys for the usageRecords 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. App subscriptions created through the GraphQL Admin API are activated upon approval.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACTIVE",
"description": "The app subscription has been activated by the app. Active app subscriptions are charged to the store and partners recieve payouts for active app subscriptions.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DECLINED",
"description": "The app subscription was declined by the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": "The app subscription was not accepted within 2 days of being created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FROZEN",
"description": "The app subscription is on hold due to a store subscription non-payment. The charge will re-activate once subscription payments resume.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCELLED",
"description": "The app subscription was cancelled by the app.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppPurchaseOneTimeConnection",
"description": null,
"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": "AppPurchaseOneTimeEdge",
"description": null,
"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": "OBJECT",
"name": "AppPurchaseOneTime",
"description": "Services and features purchased once by a store.",
"fields": [
{
"name": "createdAt",
"description": "The date and time when the app purchase was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "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. Possible values include pending, active, declined and cancelled.",
"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": "INTERFACE",
"name": "AppPurchase",
"description": "Services and features purchased once by the store.",
"fields": [
{
"name": "createdAt",
"description": "The date and time when the app purchase was created.",
"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. Possible values include pending, active, declined and cancelled.",
"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": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AppPurchaseOneTime",
"ofType": null
}
]
},
{
"kind": "ENUM",
"name": "AppPurchaseStatus",
"description": "The status of the purchase.",
"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": false,
"deprecationReason": null
},
{
"name": "ACTIVE",
"description": "The app purchase has been activated by the app. Active app purchases are charged to the store and partners receive payouts for active app purchase.",
"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 2 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": "ENUM",
"name": "AppTransactionSortKeys",
"description": "The set of valid sort keys for the oneTimePurchases 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": "AppCreditConnection",
"description": null,
"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": "AppCreditEdge",
"description": null,
"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": "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": "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": "AppSubscriptionConnection",
"description": null,
"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": "AppSubscriptionEdge",
"description": null,
"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": "ENUM",
"name": "AppSubscriptionSortKeys",
"description": "The set of valid sort keys for the allSubscriptions 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": "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 email marketing.\n",
"fields": [
{
"name": "acceptsMarketing",
"description": "Whether the customer has agreed to receive marketing materials.",
"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://help.shopify.com/api/getting-started/search-syntax).\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": "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": "marketingOptInLevel",
"description": "The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) 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 will be null.\n",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerMarketingOptInLevel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "The metafield associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Container for a set of metafields (maximum of 20 characters).",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
},
{
"name": "key",
"description": "Identifier for the metafield (maximum of 30 characters).",
"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": "metafields",
"description": "A paginated list of metafields associated with the resource.",
"args": [
{
"name": "namespace",
"description": "Finds all metafields with a specific namespace under the resource.",
"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": "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_id`\n - `chargeback_status`\n - `checkout_token`\n - `created_at`\n - `credit_card_last4`\n - `customer_id`\n - `discount_code`\n - `email`\n - `financial_status`\n - `fraud_protection_level`\n - `fulfillment_status`\n - `location_id`\n - `processed_at`\n - `reference_location_id`\n - `risk_level`\n - `sales_channel`\n - `source_name`\n - `status`\n - `tag`\n - `test`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).\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.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UnsignedInt64",
"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 found by namespace and key.",
"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.",
"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": "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": "tags",
"description": "A list of tags assigned 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.",
"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
},
{
"kind": "INTERFACE",
"name": "CommentEventSubject",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasMetafields",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "HasEvents",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxExemption",
"description": "Available customer tax exemptions.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CA_STATUS_CARD_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_BC_RESELLER_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_MB_RESELLER_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_SK_RESELLER_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_DIPLOMAT_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_BC_COMMERCIAL_FISHERY_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_MB_COMMERCIAL_FISHERY_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_NS_COMMERCIAL_FISHERY_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_PE_COMMERCIAL_FISHERY_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_SK_COMMERCIAL_FISHERY_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_BC_SUB_CONTRACTOR_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_SK_SUB_CONTRACTOR_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_BC_CONTRACTOR_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_SK_CONTRACTOR_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_ON_PURCHASE_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_MB_FARMER_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_NS_FARMER_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_SK_FARMER_EXEMPTION",
"description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderConnection",
"description": null,
"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": "OrderEdge",
"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": "OrderEdge",
"description": null,
"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 OrderEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderSortKeys",
"description": "The set of valid sort keys for the orders query.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ORDER_NUMBER",
"description": "Sort by the `order_number` 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": "FINANCIAL_STATUS",
"description": "Sort by the `financial_status` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_STATUS",
"description": "Sort by the `fulfillment_status` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOTAL_PRICE",
"description": "Sort by the `total_price` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_NAME",
"description": "Sort by the `customer_name` value.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PROCESSED_AT",
"description": "Sort by the `processed_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": "MailingAddressEdge",
"description": null,
"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 MailingAddressEdge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MailingAddress",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerMarketingOptInLevel",
"description": "The valid values for the marketing subscription opt-in active at the time the customer consented to email\nmarketing.\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": "The customer started receiving marketing email(s) after providing their email address, without any\nintermediate steps.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONFIRMED_OPT_IN",
"description": "After providing their email address, the customer received a confirmation email which required them to\nperform a prescribed action before receiving marketing emails.\n",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNKNOWN",
"description": "The customer receives marketing emails, but the original opt-in process is unknown.\n",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerJourney",
"description": "Represents a customer's activity 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": "INTERFACE",
"name": "CustomerMoment",
"description": "Represents events preceding a customer order, such as shop sessions.",
"fields": [
{
"name": "occurredAt",
"description": "When the customer moment occurred.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "CustomerVisit",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "CustomerVisit",
"description": "Information about a customer's session on a shop's online store.",
"fields": [
{
"name": "id",
"description": "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": "When the customer moment 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": "OBJECT",
"name": "MarketingEvent",
"description": "Represents actions that market a merchant's store or products.",
"fields": [
{
"name": "app",
"description": "The app that the marketing event is attributed to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "The marketing channel used by the marketing event.",
"args": [],
"type": {
"kind": "ENUM",
"name": "MarketingChannel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "A human-readable description of the marketing event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endedAt",
"description": "The date and time when the marketing event ended.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"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": "manageUrl",
"description": "The URL where the marketing event can be managed.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "previewUrl",
"description": "The URL where the marketing event can be previewed.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "URL",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "remoteId",
"description": "An optional ID that helps Shopify validate engagement data.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "scheduledToEndAt",
"description": "The date and time when the marketing event is scheduled to end.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceAndMedium",
"description": "Where the `MarketingEvent` occurred and what kind of content was used.\nBecause `utmSource` and `utmMedium` are often used interchangeably, this is\nbased on a combination of `marketingChannel`, `referringDomain`, and `type` to\nprovide a consistent representation for any given piece of marketing\nregardless of the app that created it.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startedAt",
"description": "The date and time when the marketing event started.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetTypeDisplayText",
"description": "The display text for the marketing event type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `sourceAndMedium` instead"
},
{
"name": "type",
"description": "The marketing event type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MarketingTactic",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "utmCampaign",
"description": "The name of the marketing campaign.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "utmMedium",
"description": "The medium that the marketing campaign is using. Example values: `cpc`, `banner`.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "utmSource",
"description": "The referrer of the marketing event. Example values: `google`, `newsletter`.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "LegacyInteroperability",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MarketingTactic",
"description": "The available types of marketing event.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ABANDONED_CART",
"description": "An abandoned cart recovery email.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AD",
"description": "An ad, such as a Facebook ad.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AFFILIATE",
"description": "An affiliate link.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LINK",
"description": "A link.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LOYALTY",
"description": "A loyalty program.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MESSAGE",
"description": "A messaging app, such as Facebook Messenger.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NEWSLETTER",
"description": "A newsletter.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTIFICATION",
"description": "A notification in the Shopify admin.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "POST",
"description": "A blog post.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RETARGETING",
"description": "A retargeting ad.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTIONAL",
"description": "A transactional email.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SEO",
"description": "Search engine optimization.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DIRECT",
"description": "A direct visit to the online store.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STOREFRONT_APP",
"description": "Popup on merchant's store.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DISPLAY",
"description": "A display ad.",
"isDeprecated": true,
"deprecationReason": "`DISPLAY` is deprecated. Use `AD` instead."
},
{
"name": "SEARCH",
"description": "Paid search.",
"isDeprecated": true,
"deprecationReason": "`SEARCH` is deprecated. Use `AD` instead."
},
{
"name": "FOLLOW_UP",
"description": "A follow-up email.",
"isDeprecated": true,
"deprecationReason": "'FOLLOW_UP' is deprecated. Use 'TRANSACTIONAL' instead."
},
{
"name": "RECEIPT",
"description": "A promotional receipt.",
"isDeprecated": true,
"deprecationReason": "'RECEIPT' is deprecated. Use 'TRANSACTIONAL' instead."
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MarketingChannel",
"description": "The available marketing channels for a marketing activity or event. A marketing channel is broad category of marketing, used for reporting aggregation.\n",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SEARCH",
"description": "Paid search.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DISPLAY",
"description": "Displayed ads.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SOCIAL",
"description": "Social media.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL",
"description": "Email.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFERRAL",
"description": "Referral links.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UTMParameters",
"description": null,
"fields": [
{
"name": "campaign",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "content",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "medium",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "source",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "term",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountApplicationConnection",
"description": null,
"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": null,
"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": "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": null,
"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": 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": "PricingValue",
"description": "The value of the pricing object.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "PricingPercentageValue",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MoneyV2",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "PricingPercentageValue",
"description": "The value of the percentage pricing object.",
"fields": [
{
"name": "percentage",
"description": "The percentage value of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderDisplayFinancialStatus",
"description": "Represents the order's current financial status.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PENDING",
"description": "Displayed as **Pending**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTHORIZED",
"description": "Displayed as **Authorized**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_PAID",
"description": "Displayed as **Partially paid**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_REFUNDED",
"description": "Displayed as **Partially refunded**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOIDED",
"description": "Displayed as **Voided**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAID",
"description": "Displayed as **Paid**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUNDED",
"description": "Displayed as **Refunded**.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderDisputeSummary",
"description": "A summary of the important details for a dispute on an order.",
"fields": [
{
"name": "id",
"description": "Globally unique identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "initiatedAs",
"description": "The type that the dispute was initiated as.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DisputeType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "The current status of the dispute.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DisputeStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DisputeStatus",
"description": "The possible statuses of a dispute.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NEEDS_RESPONSE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNDER_REVIEW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE_REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCEPTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WON",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LOST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DisputeType",
"description": "The possible types for a dispute.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CHARGEBACK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INQUIRY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderDisplayFulfillmentStatus",
"description": "Represents the order's current fulfillment status. Valid values are: unfulfilled, partial, fulfilled, restocked.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "UNFULFILLED",
"description": "Displayed as **Unfulfilled**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_FULFILLED",
"description": "Displayed as **Partially fulfilled**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLED",
"description": "Displayed as **Fulfilled**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RESTOCKED",
"description": "Displayed as **Restocked**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PENDING_FULFILLMENT",
"description": "Displayed as **Pending fulfillment**.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OPEN",
"description": "Displayed as **Open**.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftFulfillment",
"description": "Returns unfulfilled line items grouped by their fulfillment service. Each draft fulfillment contains additional information, such as whether the fulfillment requires shipping and whether a shipping label can be printed for it.\n",
"fields": [
{
"name": "allowLabelPurchase",
"description": "Whether a label can be purchased.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineItems",
"description": "The line items (which might correspond to a variant) that are part of this draft fulfillment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LineItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiresShipping",
"description": "Whether a fulfillment requires shipping.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "service",
"description": "The service responsible for fulfilling the fulfillment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "FulfillmentService",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "LineItem",
"description": "Represents a single line in a shopping cart.",
"fields": [
{
"name": "canRestock",
"description": "Whether the line item's variant has an ID and inventory is managed by Shopify.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `restockable` instead"
},
{
"name": "customAttributes",
"description": "List of additional information (metafields) 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": false,
"deprecationReason": null
},
{
"name": "discountedTotal",
"description": "The total line price after discounts are applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `discountedTotalSet` instead"
},
{
"name": "discountedTotalSet",
"description": "The total line price after discounts are applied in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountedUnitPrice",
"description": "The price of a single variant unit after line item discounts are applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `discountedUnitPriceSet` instead"
},
{
"name": "discountedUnitPriceSet",
"description": "The price of a single variant unit after line item discounts are applied in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillableQuantity",
"description": "The total number of units to fulfill.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"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",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "FulfillmentService",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentStatus",
"description": "The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,\n'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.\n",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "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": [
{
"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": "merchantEditable",
"description": "Whether the line item can be edited or not.",
"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": "nonFulfillableQuantity",
"description": "A count of the number of line items that cannot be fulfilled.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"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": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `originalTotalSet` instead"
},
{
"name": "originalTotalSet",
"description": "Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "originalUnitPrice",
"description": "Variant price without any discounts applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `originalUnitPriceSet` instead"
},
{
"name": "originalUnitPriceSet",
"description": "Variant price without any discounts applied in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "The Product object associated with this line item's variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Number of variant items ordered.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refundableQuantity",
"description": "The line item's quantity minus its refundedQuantity.",
"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": "restockable",
"description": "Whether the line item's variant has an ID and inventory is managed by Shopify.",
"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": "taxLines",
"description": "The TaxLine object connected to this line item.",
"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": "TaxLine",
"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": "The sum of all AppliedDiscounts on this line item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `totalDiscountSet` instead"
},
{
"name": "totalDiscountSet",
"description": "The sum of all AppliedDiscounts on this line item in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unfulfilledDiscountedTotal",
"description": "The total discounted value of unfulfilled units.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `unfulfilledDiscountedTotalSet` instead"
},
{
"name": "unfulfilledDiscountedTotalSet",
"description": "The total discounted value of unfulfilled units in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unfulfilledOriginalTotal",
"description": "The total value before discount of all unfulfilled units.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "Use `unfulfilledOriginalTotalSet` instead"
},
{
"name": "unfulfilledOriginalTotalSet",
"description": "The total value before discount of all unfulfilled units in shop and presentment currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MoneyBag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unfulfilledQuantity",
"description": "The number of units not yet fulfilled.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variant",
"description": "The Variant object associated with this 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":
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment