--- title: MetafieldReferencer - GraphQL Admin description: Types of resources that may use metafields to reference other resources. api_version: 2025-10 api_name: admin type: union api_type: graphql source_url: html: https://shopify.dev/docs/api/admin-graphql/latest/unions/MetafieldReferencer md: https://shopify.dev/docs/api/admin-graphql/latest/unions/MetafieldReferencer.md --- # Metafield​Referencer union Types of resources that may use metafields to reference other resources. ## Possible types * [App​Installation](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation) OBJECT Represents an installed application on a shop. * access​Scopes [\[Access​Scope!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) non-null The access scopes granted to the application by a merchant during installation. * active​Subscriptions [\[App​Subscription!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) non-null The active application subscriptions billed to the shop on a recurring basis. * all​Subscriptions [App​Subscription​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/AppSubscriptionConnection) non-null All subscriptions created for a shop. * app [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null Application which is installed. * credits [App​Credit​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/AppCreditConnection) non-null Credits that can be used towards future app purchases. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * launch​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL to launch the application. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * one​Time​Purchases [App​Purchase​One​Time​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/AppPurchaseOneTimeConnection) non-null One-time purchases to a shop. * publication [Publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) The publication associated with the installed application. * revenue​Attribution​Records [App​Revenue​Attribution​Record​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/AppRevenueAttributionRecordConnection) non-null The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes. * uninstall​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL to uninstall the application. * channel [Channel](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) Deprecated * subscriptions [\[App​Subscription!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) non-nullDeprecated * [Article](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article) OBJECT An article in the blogging system. * author [Article​Author](https://shopify.dev/docs/api/admin-graphql/latest/objects/ArticleAuthor) The name of the author of the article. * blog [Blog!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Blog) non-null The blog containing the article. * body [HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) non-null The text of the article's body, complete with HTML markup. * comments [Comment​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CommentConnection) non-null List of the article's comments. * comments​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) Count of comments. Limited to a maximum of 10000 by default. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time (ISO 8601 format) when the article was created. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * image [Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) The image associated with the article. * is​Published [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether or not the article is visible. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * published​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible. * summary [HTML](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values. * template​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the template an article is using if it's using an alternate template. If an article is using the default `article.liquid` template, then the value returned is `null`. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the article. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * updated​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time (ISO 8601 format) when the article was last updated. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Blog](https://shopify.dev/docs/api/admin-graphql/latest/objects/Blog) OBJECT Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time. * articles [Article​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ArticleConnection) non-null List of the blog's articles. * articles​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) Count of articles. Limited to a maximum of 10000 by default. * comment​Policy [Comment​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CommentPolicy) non-null Indicates whether readers can post comments to the blog and if comments are moderated or not. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the blog was created. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * feed [Blog​Feed](https://shopify.dev/docs/api/admin-graphql/latest/objects/BlogFeed) FeedBurner provider details. Any blogs that aren't already integrated with FeedBurner can't use the service. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique, human-friendly string for the blog. If no handle is specified, a handle will be generated automatically from the blog title. The handle is customizable and is used by the Liquid templating language to refer to the blog. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A list of tags associated with the 200 most recent blog articles. * template​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the template a blog is using if it's using an alternate template. Returns `null` if a blog is using the default blog.liquid template. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the blog. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * updated​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the blog was update. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) OBJECT The `Collection` object represents a group of [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across [online stores](https://shopify.dev/docs/apps/build/online-store), [sales channels](https://shopify.dev/docs/apps/build/sales-channels), and marketing campaigns. There are two types of collections: * **[Custom (manual) collections](https://help.shopify.com/manual/products/collections/manual-shopify-collection)**: You specify the products to include in a collection. * **[Smart (automated) collections](https://help.shopify.com/manual/products/collections/automated-collections)**: You define rules, and products matching those rules are automatically included in the collection. The `Collection` object provides information to: * Organize products by category, season, or promotion. * Automate product grouping using rules (for example, by tag, type, or price). * Configure product sorting and display order (for example, alphabetical, best-selling, price, or manual). * Manage collection visibility and publication across sales channels. * Add rich descriptions, images, and metadata to enhance discovery. *** Note Collections are unpublished by default. To make them available to customers, use the [`publishablePublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publishablePublish) mutation after creation. *** Collections can be displayed in a store with Shopify's theme system through [Liquid templates](https://shopify.dev/docs/storefronts/themes/architecture/templates/collection) and can be customized with [template suffixes](https://shopify.dev/docs/storefronts/themes/architecture/templates/alternate-templates) for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs. Learn about [using metafields with smart collections](https://shopify.dev/docs/apps/build/custom-data/metafields/use-metafield-capabilities). * available​Publications​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). * description [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description. * truncate​At [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) ### Arguments Truncates a string after the given length. *** * description​Html [HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) non-null The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * feedback [Resource​Feedback](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback) Information about the collection that's provided through resource feedback. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title `Summer Catalog 2022` might have the handle `summer-catalog-2022`. If the title is changed, the handle doesn't automatically change. The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes. * has​Product [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the collection includes the specified product. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the product to check. *** * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * image [Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) The image associated with the collection. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * products [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-null The products that are included in the collection. * products​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of products in the collection. * published​On​Current​Publication [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the resource is published to the app's [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). For example, the resource might be published to the app's online store channel. * published​On​Publication [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the resource is published to a specified [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). * publication​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the publication to check. For example, `id: "gid://shopify/Publication/123"`. *** * resource​Publications [Resource​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection) non-null The list of resources that are published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). * resource​Publications​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). * resource​Publications​V2 [Resource​Publication​V2Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationV2Connection) non-null The list of resources that are either published or staged to be published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). * rule​Set [Collection​Rule​Set](https://shopify.dev/docs/api/admin-graphql/latest/objects/CollectionRuleSet) For a smart (automated) collection, specifies the rules that determine whether a product is included. * seo [SEO!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SEO) non-null If the default SEO fields for page title and description have been modified, contains the modified information. * sort​Order [Collection​Sort​Order!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CollectionSortOrder) non-null The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store. * template​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template. If the value is `null`, then the collection is using the default `collection.liquid` template. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * unpublished​Publications [Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PublicationConnection) non-null The list of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that the resource isn't published to. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * publication​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * only​Published [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:true ### Arguments Include only the resource's publications that are published. If false, then return all the resource's publications including future publications. *** * publications [Collection​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CollectionPublicationConnection) non-nullDeprecated * published​On​Channel [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * channel​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the channel to check. *** * published​On​Current​Channel [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * storefront​Id [Storefront​ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/StorefrontID) non-nullDeprecated * unpublished​Channels [Channel​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ChannelConnection) non-nullDeprecated * [Company](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) OBJECT Represents information about a company which is also a customer of the shop. * contact​Roles [Company​Contact​Role​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CompanyContactRoleConnection) non-null The list of roles for the company contacts. * contacts [Company​Contact​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CompanyContactConnection) non-null The list of contacts in the company. * contacts​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of contacts that belong to the company. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was created in Shopify. * customer​Since [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company became the customer. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. * default​Role [Company​Contact​Role](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContactRole) The role proposed by default for a contact at the company. * draft​Orders [Draft​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DraftOrderConnection) non-null The list of the company's draft orders. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * external​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique externally-supplied ID for the company. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the merchant added a timeline comment to the company. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * lifetime​Duration [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The lifetime duration of the company, since it became a customer of the shop. Examples: `2 days`, `3 months`, `1 year`. * locations [Company​Location​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CompanyLocationConnection) non-null The list of locations in the company. * locations​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of locations that belong to the company. * main​Contact [Company​Contact](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) The main contact for the company. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the company. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note about the company. * orders [Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderConnection) non-null The list of the company's orders. * orders​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The total number of orders placed for this company, across all its locations. * total​Spent [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The total amount spent by this company, across all its locations. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was last modified. * contact​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Company​Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) OBJECT A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. * billing​Address [Company​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyAddress) The address used as billing address for the location. * buyer​Experience​Configuration [Buyer​Experience​Configuration](https://shopify.dev/docs/api/admin-graphql/latest/objects/BuyerExperienceConfiguration) The configuration for the buyer's B2B checkout. * catalogs [Catalog​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CatalogConnection) non-null The list of catalogs associated with the company location. * catalogs​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of catalogs associated with the company location. Limited to a maximum of 10000 by default. * company [Company!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) non-null The company that the company location belongs to. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify. * currency [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. * draft​Orders [Draft​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DraftOrderConnection) non-null The list of draft orders for the company location. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * external​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique externally-supplied ID for the company location. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the merchant added a timeline comment to the company location. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * in​Catalog [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the company location is assigned a specific catalog. * catalog​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the catalog. *** * locale [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The preferred locale of the company location. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the company location. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note about the company location. * orders [Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderConnection) non-null The list of orders for the company location. * orders​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The total number of orders placed for the location. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The phone number of the company location. * role​Assignments [Company​Contact​Role​Assignment​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CompanyContactRoleAssignmentConnection) non-null The list of roles assigned to the company location. * shipping​Address [Company​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyAddress) The address used as shipping address for the location. * staff​Member​Assignments [Company​Location​Staff​Member​Assignment​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CompanyLocationStaffMemberAssignmentConnection) non-null The list of staff members assigned to the company location. * store​Credit​Accounts [Store​Credit​Account​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StoreCreditAccountConnection) non-null Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency. * tax​Settings [Company​Location​Tax​Settings!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocationTaxSettings) non-null The tax settings for the company location. * total​Spent [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The total amount spent by the location. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified. * market [Market!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * order​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * tax​Exemptions [\[Tax​Exemption!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/TaxExemption) non-nullDeprecated * tax​Registration​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) OBJECT Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email. **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. * addresses [\[Mailing​Address!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) non-null A list of addresses associated with the customer. * addresses​V2 [Mailing​Address​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MailingAddressConnection) non-null The addresses associated with the customer. * amount​Spent [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The total amount that the customer has spent on orders in their lifetime. * can​Delete [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the merchant can delete the customer from their store. A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an order, they can't be deleted from a store. * company​Contact​Profiles [\[Company​Contact!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) non-null A list of the customer's company contact profiles. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the customer was added to the store. * data​Sale​Opt​Out [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer has opted out of having their data sold. * default​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The default address associated with the customer. * default​Email​Address [Customer​Email​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerEmailAddress) The customer's default email address. * default​Phone​Number [Customer​Phone​Number](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPhoneNumber) The customer's default phone number. * display​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The full name of the customer, based on the values for first\_name and last\_name. If the first\_name and last\_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null A list of events associated with the customer. * first​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer's first name. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * image [Image!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) non-null The image associated with the customer. * last​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer's last name. * last​Order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The customer's last order. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * lifetime​Duration [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The amount of time since the customer was first added to the store. Example: 'about 12 years'. * locale [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The customer's locale. * mergeable [Customer​Mergeable!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerMergeable) non-null Whether the customer can be merged with another customer. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * multipass​Identifier [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique identifier for the customer that's used with Multipass login. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note about the customer. * number​Of​Orders [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The number of orders that the customer has made at the store in their lifetime. * orders [Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderConnection) non-null A list of the customer's orders. * payment​Methods [Customer​Payment​Method​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CustomerPaymentMethodConnection) non-null A list of the customer's payment methods. * product​Subscriber​Status [Customer​Product​Subscriber​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerProductSubscriberStatus) non-null Possible subscriber states of a customer defined by their subscription contracts. * state [Customer​State!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerState) non-null The state of the customer's account with the shop. Please note that this only meaningful when Classic Customer Accounts is active. * statistics [Customer​Statistics!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerStatistics) non-null The statistics for a given customer. * store​Credit​Accounts [Store​Credit​Account​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StoreCreditAccountConnection) non-null Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency. * subscription​Contracts [Subscription​Contract​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionContractConnection) non-null A list of the customer's subscription contracts. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A comma separated list of tags that have been added to the customer. * tax​Exempt [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer is exempt from being charged taxes on their orders. * tax​Exemptions [\[Tax​Exemption!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/TaxExemption) non-null The list of tax exemptions applied to the customer. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the customer was last updated. * verified​Email [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API. * email [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * email​Marketing​Consent [Customer​Email​Marketing​Consent​State](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerEmailMarketingConsentState) Deprecated * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * market [Market](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) Deprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * sms​Marketing​Consent [Customer​Sms​Marketing​Consent​State](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerSmsMarketingConsentState) Deprecated * unsubscribe​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-nullDeprecated * valid​Email​Address [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * [Delivery​Customization](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCustomization) OBJECT A delivery customization. * enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null The enabled status of the delivery customization. * error​History [Functions​Error​History](https://shopify.dev/docs/api/admin-graphql/latest/objects/FunctionsErrorHistory) The error history on the most recent version of the delivery customization. * function​Id [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The ID of the Shopify Function implementing the delivery customization. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * shopify​Function [Shopify​Function!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyFunction) non-null The Shopify Function implementing the delivery customization. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the delivery customization. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Discount​Automatic​Node](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticNode) OBJECT The `DiscountAutomaticNode` object enables you to manage [automatic discounts](https://help.shopify.com/manual/discounts/discount-types#automatic-discounts) that are applied when an order meets specific criteria. You can create amount off, free shipping, or buy X get Y automatic discounts. For example, you can offer customers a free shipping discount that applies when conditions are met. Or you can offer customers a buy X get Y discount that's automatically applied when customers spend a specified amount of money, or a specified quantity of products. Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts), including related queries, mutations, limitations, and considerations. * automatic​Discount [Discount​Automatic!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountAutomatic) non-null A discount that's applied automatically when an order meets specific criteria. Learn more about [automatic discounts](https://help.shopify.com/manual/discounts/discount-types#automatic-discounts). * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Discount​Code​Node](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeNode) OBJECT The `DiscountCodeNode` object enables you to manage [code discounts](https://help.shopify.com/manual/discounts/discount-types#discount-codes) that are applied when customers enter a code at checkout. For example, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store. Or, you can offer discounts where customers have to enter a code to get free shipping. Merchants can create and share discount codes individually with customers. Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts), including related queries, mutations, limitations, and considerations. * code​Discount [Discount​Code!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountCode) non-null The underlying code discount object. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Discount​Node](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountNode) OBJECT The `DiscountNode` object enables you to manage [discounts](https://help.shopify.com/manual/discounts), which are applied at checkout or on a cart. Discounts are a way for merchants to promote sales and special offers, or as customer loyalty rewards. Discounts can apply to [orders, products, or shipping](https://shopify.dev/docs/apps/build/discounts#discount-classes), and can be either automatic or code-based. For example, you can offer customers a buy X get Y discount that's automatically applied when purchases meet specific criteria. Or, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store. Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts), including related mutations, limitations, and considerations. * discount [Discount!](https://shopify.dev/docs/api/admin-graphql/latest/unions/Discount) non-null A discount that's applied at checkout or on cart. Discounts can be [automatic or code-based](https://shopify.dev/docs/apps/build/discounts#discount-methods). * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Draft​Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder) OBJECT An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: * Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. * Send invoices to customers to pay with a secure checkout link. * Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. * Re-create orders manually from active sales channels. * Sell products at discount or wholesale rates. * Take pre-orders. For draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their shop currency. **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity. * accept​Automatic​Discounts [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see `appliedDiscount`) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts. * allow​Discount​Codes​In​Checkout [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether discount codes are allowed during checkout of this draft order. * all​Variant​Prices​Overridden [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether all variant prices have been overridden. * any​Variant​Prices​Overridden [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether any variant prices have been overridden. * applied​Discount [Draft​Order​Applied​Discount](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderAppliedDiscount) The custom order-level discount applied. * billing​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The billing address of the customer. * billing​Address​Matches​Shipping​Address [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the billing address matches the shipping address. * completed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the draft order was converted to a new order, and had it's status changed to **Completed**. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the draft order was created in Shopify. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The shop currency used for calculation. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null The custom information added to the draft order on behalf of the customer. * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer who will be sent an invoice. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. * discount​Codes [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null All discount codes applied. * email [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The email address of the customer, which is used to send notifications. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The list of events associated with the draft order. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the merchant has added timeline comments to the draft order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * invoice​Email​Template​Subject [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The subject defined for the draft invoice email template. * invoice​Sent​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the invoice was last emailed to the customer. * invoice​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The link to the checkout, which is sent to the customer in the invoice email. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * line​Items [Draft​Order​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DraftOrderLineItemConnection) non-null The list of the line items in the draft order. * line​Items​Subtotal​Price [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null A subtotal of the line items and corresponding discounts, excluding shipping charges, shipping discounts, taxes, or order discounts. * localized​Fields [Localized​Field​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocalizedFieldConnection) non-null List of localized fields for the resource. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The identifier for the draft order, which is unique within the store. For example, *#D1223*. * note2 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The text from an optional note attached to the draft order. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The order that was created from the draft order. * payment​Terms [Payment​Terms](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms) The associated payment terms for this draft order. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The assigned phone number. * platform​Discounts [\[Draft​Order​Platform​Discount!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderPlatformDiscount) non-null The list of platform discounts applied. * po​Number [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The purchase order number. * presentment​Currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The payment currency used for calculation. * purchasing​Entity [Purchasing​Entity](https://shopify.dev/docs/api/admin-graphql/latest/unions/PurchasingEntity) The purchasing entity. * ready [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the draft order is ready and can be completed. Draft orders might have asynchronous operations that can take time to finish. * reserve​Inventory​Until [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The time after which inventory will automatically be restocked. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The shipping address of the customer. * shipping​Line [Shipping​Line](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShippingLine) The line item containing the shipping information and costs. * status [Draft​Order​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DraftOrderStatus) non-null The status of the draft order. * subtotal​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The comma separated list of tags associated with the draft order. Updating `tags` overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. * taxes​Included [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the line item prices include taxes. * tax​Exempt [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the draft order is tax exempt. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null The list of of taxes lines charged for each line item and shipping line. * total​Discounts​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null Total discounts. * total​Line​Items​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null Total price of line items, excluding discounts. * total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price, includes taxes, shipping charges, and discounts. * total​Quantity​Of​Line​Items [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The sum of individual line item quantities. If the draft order has bundle items, this is the sum containing the quantities of individual items in the bundle. * total​Shipping​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total shipping price. * total​Tax​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total tax. * total​Weight [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The total weight in grams of the draft order. * transformer​Fingerprint [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Fingerprint of the current cart. In order to have bundles work, the fingerprint must be passed to each request as it was previously returned, unmodified. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the draft order was last changed. The format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01. * visible​To​Customer [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the draft order will be visible to the customer on the self-serve portal. * warnings [\[Draft​Order​Warning!\]!](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/DraftOrderWarning) non-null The list of warnings raised while calculating. * localization​Extensions [Localization​Extension​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocalizationExtensionConnection) non-nullDeprecated * market​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-nullDeprecated * market​Region​Country​Code [Country​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) non-nullDeprecated * subtotal​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Shipping​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Tax [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * [Fulfillment​Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) OBJECT The FulfillmentOrder object represents either an item or a group of items in an [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) that are expected to be fulfilled from the same location. There can be more than one fulfillment order for an [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) at a given location. ![](https://shopify.dev/assets/api/reference/fulfillment_order_relationships.png) Fulfillment orders represent the work which is intended to be done in relation to an order. When fulfillment has started for one or more line items, a [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) is created by a merchant or third party to represent the ongoing or completed work of fulfillment. [See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service). *** Note Shopify creates fulfillment orders automatically when an order is created. It is not possible to manually create fulfillment orders. [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order). *** ## Retrieving fulfillment orders ### Fulfillment orders from an order All fulfillment orders related to a given order can be retrieved with the [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) connection. [API access scopes](#api-access-scopes) govern which fulfillments orders are returned to clients. An API client will only receive a subset of the fulfillment orders which belong to an order if they don't have the necessary access scopes to view all of the fulfillment orders. ### Fulfillment orders assigned to the app for fulfillment Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the [assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/2024-07/objects/queryroot#connection-assignedfulfillmentorders) connection. Use the `assignmentStatus` argument to control whether all assigned fulfillment orders should be returned or only those where a merchant has sent a [fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) and it has yet to be responded to. The API client must be granted the `read_assigned_fulfillment_orders` access scope to access the assigned fulfillment orders. ### All fulfillment orders Apps can retrieve all fulfillment orders with the [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders) query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, which are accessible to the app according to the [fulfillment order access scopes](#api-access-scopes) it was granted with. ## The lifecycle of a fulfillment order ### Fulfillment Order Creation After an order is created, a background worker performs the order routing process which determines which locations will be responsible for fulfilling the purchased items. Once the order routing process is complete, one or more fulfillment orders will be created and assigned to these locations. It is not possible to manually create fulfillment orders. Once a fulfillment order has been created, it will have one of two different lifecycles depending on the type of location which the fulfillment order is assigned to. ### The lifecycle of a fulfillment order at a merchant managed location Fulfillment orders are completed by creating [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). Fulfillments represents the work done. For digital products a merchant or an order management app would create a fulfilment once the digital asset has been provisioned. For example, in the case of a digital gift card, a merchant would to do this once the gift card has been activated - before the email has been shipped. On the other hand, for a traditional shipped order, a merchant or an order management app would create a fulfillment after picking and packing the items relating to a fulfillment order, but before the courier has collected the goods. [Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments). ### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service For fulfillment orders which are assigned to a location that is managed by a fulfillment service, a merchant or an Order Management App can [send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) to the fulfillment service which operates the location to request that they fulfill the associated items. A fulfillment service has the option to [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) this fulfillment request. Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant or order management app and instead a [cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) to the fulfillment service. Once a fulfillment service accepts a fulfillment request, then after they are ready to pack items and send them for delivery, they create fulfillments with the [fulfillmentCreate](https://shopify.dev/api/admin-graphql/unstable/mutations/fulfillmentCreate) mutation. They can provide tracking information right away or create fulfillments without it and then update the tracking information for fulfillments with the [fulfillmentTrackingInfoUpdate](https://shopify.dev/api/admin-graphql/unstable/mutations/fulfillmentTrackingInfoUpdate) mutation. [Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments). ## API access scopes Fulfillment orders are governed by the following API access scopes: * The `read_merchant_managed_fulfillment_orders` and `write_merchant_managed_fulfillment_orders` access scopes grant access to fulfillment orders assigned to merchant-managed locations. * The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders` access scopes are intended for fulfillment services. These scopes grant access to fulfillment orders assigned to locations that are being managed by fulfillment services. * The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders` access scopes grant access to fulfillment orders assigned to locations managed by other fulfillment services. ### Fulfillment service app access scopes Usually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope and don't have the `*_third_party_fulfillment_orders` or `*_merchant_managed_fulfillment_orders` access scopes. The app will only have access to the fulfillment orders assigned to their location (or multiple locations if the app registers multiple fulfillment services on the shop). The app will not have access to fulfillment orders assigned to merchant-managed locations or locations owned by other fulfillment service apps. ### Order management app access scopes **Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and `write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders on behalf of a merchant. If an app combines the functions of an order management app and a fulfillment service, then the app should request all access scopes to manage all assigned and all unassigned fulfillment orders. ## Notifications about fulfillment orders Fulfillment services are required to [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified whenever a merchant submits a fulfillment or cancellation request. Both merchants and apps can [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) to the [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) to be notified whenever fulfillment order related domain events occur. [Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment). * assigned​Location [Fulfillment​Order​Assigned​Location!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderAssignedLocation) non-null The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen. The fulfillment order's assigned location might change in the following cases: * The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder) field within the mutation's response. * Work on the fulfillment order hasn't yet begun, which means that the fulfillment order has the [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open), [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or [ON\_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold) status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin). * channel​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) ID of the channel that created the order. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null Date and time when the fulfillment order was created. * delivery​Method [Delivery​Method](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryMethod) Delivery method of this fulfillment order. * destination [Fulfillment​Order​Destination](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderDestination) The destination where the items should be sent. * fulfill​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the `fulfill_at` date for a subscription order might be the 1st of each month, a pre-order `fulfill_at` date would be `nil`, and a standard order `fulfill_at` date would be the order creation date. * fulfill​By [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The latest date and time by which all items in the fulfillment order need to be fulfilled. * fulfillment​Holds [\[Fulfillment​Hold!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentHold) non-null The fulfillment holds applied on the fulfillment order. * fulfillment​Orders​For​Merge [Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderConnection) non-null Fulfillment orders eligible for merging with the given fulfillment order. * fulfillments [Fulfillment​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentConnection) non-null A list of fulfillments for the fulfillment order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * international​Duties [Fulfillment​Order​International​Duties](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderInternationalDuties) The duties delivery method of this fulfillment order. * line​Items [Fulfillment​Order​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderLineItemConnection) non-null A list of the fulfillment order's line items. * locations​For​Move [Fulfillment​Order​Location​For​Move​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderLocationForMoveConnection) non-null A list of locations that the fulfillment order can potentially move to. * merchant​Requests [Fulfillment​Order​Merchant​Request​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderMerchantRequestConnection) non-null A list of requests sent by the merchant or an order management app to the fulfillment service for the fulfillment order. * order [Order!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) non-null The order that's associated with the fulfillment order. * order​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null ID of the order that's associated with the fulfillment order. * order​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique identifier for the order that appears on the order page in the Shopify admin and the **Order status** page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. * order​Processed​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the order was processed. This date and time might not match the date and time when the order was created. * request​Status [Fulfillment​Order​Request​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus) non-null The request status of the fulfillment order. * status [Fulfillment​Order​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderStatus) non-null The status of the fulfillment order. * supported​Actions [\[Fulfillment​Order​Supported​Action!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderSupportedAction) non-null The actions that can be performed on this fulfillment order. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the fulfillment order was last updated. * [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) OBJECT Represents the location where the physical good resides. You can stock inventory at active locations. Active locations that have `fulfills_online_orders: true` and are configured with a shipping rate, pickup enabled or local delivery will be able to sell from their storefront. * activatable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the location can be reactivated. If `false`, then trying to activate the location with the [`LocationActivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationActivate) mutation will return an error that describes why the location can't be activated. * address [Location​Address!](https://shopify.dev/docs/api/admin-graphql/latest/objects/LocationAddress) non-null The address of this location. * address​Verified [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the location address has been verified. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was added to a shop. * deactivatable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this location can be deactivated. If `true`, then the location can be deactivated by calling the [`LocationDeactivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationDeactivate) mutation. If `false`, then calling the mutation to deactivate it will return an error that describes why the location can't be deactivated. * deactivated​At [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as `"2019-09-07T15:50:00Z`". * deletable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this location can be deleted. * fulfillment​Service [Fulfillment​Service](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) Name of the service provider that fulfills from this location. * fulfills​Online​Orders [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this location can fulfill online orders. * has​Active​Inventory [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this location has active inventory. * has​Unfulfilled​Orders [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this location has orders that need to be fulfilled. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * inventory​Level [Inventory​Level](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) The quantities of an inventory item at this location. * inventory​Levels [Inventory​Level​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/InventoryLevelConnection) non-null A list of the quantities of the inventory items that can be stocked at this location. * is​Active [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the location is active. A deactivated location can be activated (change `isActive: true`) if it has `activatable` set to `true` by calling the [`locationActivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationActivate) mutation. * is​Fulfillment​Service [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this location is a fulfillment service. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * local​Pickup​Settings​V2 [Delivery​Local​Pickup​Settings](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryLocalPickupSettings) Local pickup settings for the location. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the location. * ships​Inventory [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. * suggested​Addresses [\[Location​Suggested​Address!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/LocationSuggestedAddress) non-null List of suggested addresses for this location (empty if none). * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the location was last updated. * is​Primary [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Market](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) OBJECT A market is a group of one or more regions that you want to target for international sales. By creating a market, you can configure a distinct, localized shopping experience for customers from a specific area of the world. For example, you can [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). * assigned​Customization [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the market has a customization with the given ID. * customization​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the customization that the market has been assigned to. *** * catalogs [Market​Catalog​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MarketCatalogConnection) non-null The catalogs that belong to the market. * catalogs​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of catalogs that belong to the market. * conditions [Market​Conditions](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketConditions) The conditions under which a visitor is in the market. * currency​Settings [Market​Currency​Settings](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketCurrencySettings) The market’s currency settings. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A short, human-readable unique identifier for the market. This is changeable by the merchant. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the market. Not shown to customers. * price​Inclusions [Market​Price​Inclusions](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketPriceInclusions) The inclusive pricing strategy for a market. This determines if prices include duties and / or taxes. * status [Market​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketStatus) non-null Status of the market. Replaces the enabled field. * type [Market​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketType) non-null The type of the market. * web​Presences [Market​Web​Presence​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MarketWebPresenceConnection) non-null The market’s web presences, which defines its SEO strategy. This can be a different domain, subdomain, or subfolders of the primary domain. Each web presence comprises one or more language variants. If a market doesn't have any web presences, then the market is accessible on the primary market's domains using [country selectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector). * enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * price​List [Price​List](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) Deprecated * primary [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * regions [Market​Region​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MarketRegionConnection) non-nullDeprecated * web​Presence [Market​Web​Presence](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketWebPresence) Deprecated * [Metaobject](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) OBJECT Provides an object instance represented by a MetaobjectDefinition. * capabilities [Metaobject​Capability​Data!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectCapabilityData) non-null Metaobject capabilities for this Metaobject. * created​By [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The app used to create the object. * created​By​App [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The app used to create the object. * created​By​Staff [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The staff member who created the metaobject. * definition [Metaobject​Definition!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition) non-null The MetaobjectDefinition that models this object type. * display​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The preferred display name field value of the metaobject. * field [Metaobject​Field](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectField) The field for an object key, or null if the key has no field definition. * fields [\[Metaobject​Field!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectField) non-null All ordered fields of the metaobject with their definitions and values. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique handle of the object, useful as a custom ID. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * referenced​By [Metafield​Relation​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldRelationConnection) non-null List of back references metafields that belong to the resource. * thumbnail​Field [Metaobject​Field](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectField) The recommended field to visually represent this metaobject. May be a file reference or color field. * type [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The type of the metaobject. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null When the object was last updated. * staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) Deprecated * [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) OBJECT The `Order` object represents a customer's request to purchase one or more products from a store. Use the `Order` object to handle the complete purchase lifecycle from checkout to fulfillment. Use the `Order` object when you need to: * Display order details on customer account pages or admin dashboards. * Create orders for phone sales, wholesale customers, or subscription services. * Update order information like shipping addresses, notes, or fulfillment status. * Process returns, exchanges, and partial refunds. * Generate invoices, receipts, and shipping labels. The `Order` object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema. *** Note Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older records, then you need to [request access to all orders](https://shopify.dev/docs/api/usage/access-scopes#orders-permissions). If your app is granted access, then you can add the `read_all_orders`, `read_orders`, and `write_orders` scopes. *** *** Caution Only use orders data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/docs/api/usage/access-scopes#requesting-specific-permissions) for apps that don't have a legitimate use for the associated data. *** Learn more about [building apps for orders and fulfillment](https://shopify.dev/docs/apps/build/orders-fulfillment). * additional​Fees [\[Additional​Fee!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AdditionalFee) non-null A list of additional fees applied to an order, such as duties, import fees, or [tax lines](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.additionalFees.taxLines). * agreements [Sales​Agreement​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SalesAgreementConnection) non-null A list of sales agreements associated with the order, such as contracts defining payment terms, or delivery schedules between merchants and customers. * alerts [\[Resource​Alert!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceAlert) non-null A list of messages that appear on the **Orders** page in the Shopify admin. These alerts provide merchants with important information about an order's status or required actions. * app [Order​App](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderApp) The application that created the order. For example, "Online Store", "Point of Sale", or a custom app name. Use this to identify the order source for attribution and fulfillment workflows. Learn more about [building apps for orders and fulfillment](https://shopify.dev/docs/apps/build/orders-fulfillment). * billing​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The billing address associated with the payment method selected by the customer for an order. Returns `null` if no billing address was provided during checkout. * billing​Address​Matches​Shipping​Address [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the billing address matches the [shipping address](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.shippingAddress). Returns `true` if both addresses are the same, and `false` if they're different or if an address is missing. * cancellation [Order​Cancellation](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderCancellation) Details of an order's cancellation, if it has been canceled. This includes the reason, date, and any [staff notes](https://shopify.dev/api/admin-graphql/latest/objects/OrderCancellation#field-OrderCancellation.fields.staffNote). * cancelled​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when an order was canceled. Returns `null` if the order hasn't been canceled. * cancel​Reason [Order​Cancel​Reason](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderCancelReason) The reason provided for an order cancellation. For example, a merchant might cancel an order if there's insufficient inventory. Returns `null` if the order hasn't been canceled. * can​Mark​As​Paid [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether an order can be manually marked as paid. Returns `false` if the order is already paid, is canceled, has pending [Shopify Payments](https://help.shopify.com/en/manual/payments/shopify-payments/payouts) transactions, or has a negative payment amount. * can​Notify​Customer [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether order notifications can be sent to the customer. Returns `true` if the customer has a valid [email address](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.email). * capturable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether an authorized payment for an order can be captured. Returns `true` if an authorized payment exists that hasn't been fully captured yet. Learn more about [capturing payments](https://help.shopify.com/en/manual/fulfillment/managing-orders/payments/capturing-payments). * cart​Discount​Amount​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total discount amount applied at the time the order was created, displayed in both shop and presentment currencies, before returns, refunds, order edits, and cancellations. This field only includes discounts applied to the entire order. * channel​Information [Channel​Information](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelInformation) Details about the sales channel that created the order, such as the [channel app type](https://shopify.dev/docs/api/admin-graphql/latest/objects/channel#field-Channel.fields.channelType) and [channel name](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelDefinition#field-ChannelDefinition.fields.channelName), which helps to track order sources. * client​Ip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The IP address of the customer who placed the order. Useful for fraud detection and geographic analysis. * closed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether an order is closed. An order is considered closed if all its line items have been fulfilled or canceled, and all financial transactions are complete. * closed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when an order was closed. Shopify automatically records this timestamp when all items have been fulfilled or canceled, and all financial transactions are complete. Returns `null` if the order isn't closed. * confirmation​Number [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A customer-facing order identifier, often shown instead of the sequential order name. It uses a random alphanumeric format (for example, `XPAV284CT`) and isn't guaranteed to be unique across orders. * confirmed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether inventory has been reserved for an order. Returns `true` if inventory quantities for an order's [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) have been reserved. Learn more about [managing inventory quantities and states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states). * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The shop currency when the order was placed. For example, "USD" or "CAD". * current​Cart​Discount​Amount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The current total of all discounts applied to the entire order, after returns, refunds, order edits, and cancellations. This includes discount codes, automatic discounts, and other promotions that affect the whole order rather than individual line items. To get the original discount amount at the time of order creation, use the [`cartDiscountAmountSet`](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.cartDiscountAmountSet) field. * current​Shipping​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The current shipping price after applying refunds and discounts. If the parent `order.taxesIncluded` field is true, then this price includes taxes. Otherwise, this field is the pre-tax price. * current​Subtotal​Line​Items​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The current sum of the quantities for all line items that contribute to the order's subtotal price, after returns, refunds, order edits, and cancellations. * current​Subtotal​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts. * current​Tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of all tax lines applied to line items on the order, after returns. Tax line prices represent the total price for all tax lines with the same `rate` and `title`. * current​Total​Additional​Fees​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The current total of all additional fees for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations. Additional fees can include charges such as duties, import fees, and special handling. * current​Total​Discounts​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts. * current​Total​Duties​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations. * current​Total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts. * current​Total​Tax​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The sum of the prices of all tax lines applied to line items on the order, after returns and refunds, in shop and presentment currencies. * current​Total​Weight [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The total weight of the order after returns and refunds, in grams. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of additional information that has been attached to the order. For example, gift message, delivery instructions, or internal notes. * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer who placed an order. Returns `null` if an order was created through a checkout without customer authentication, such as a guest checkout. Learn more about [customer accounts](https://help.shopify.com/manual/customers/customer-accounts). * customer​Accepts​Marketing [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer agreed to receive marketing emails at the time of purchase. Use this to ensure compliance with marketing consent laws and to segment customers for email campaigns. Learn more about [building customer segments](https://shopify.dev/docs/apps/build/marketing-analytics/customer-segments). * customer​Journey​Summary [Customer​Journey​Summary](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerJourneySummary) The customer's visits and interactions with the online store before placing the order. Use this to understand customer behavior, attribution sources, and marketing effectiveness to optimize your sales funnel. * customer​Locale [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer's language and region preference at the time of purchase. For example, "en" for English, "fr-CA" for French (Canada), or "es-MX" for Spanish (Mexico). Use this to provide localized customer service and targeted marketing in the customer's preferred language. * discount​Applications [Discount​Application​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DiscountApplicationConnection) non-null A list of discounts that are applied to the order, excluding order edits and refunds. Includes discount codes, automatic discounts, and other promotions that reduce the order total. * discount​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The discount code used for an order. Returns `null` if no discount code was applied. * discount​Codes [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The discount codes used for the order. Multiple codes can be applied to a single order. * display​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The primary address of the customer, prioritizing shipping address over billing address when both are available. Returns `null` if neither shipping address nor billing address was provided. * display​Financial​Status [Order​Display​Financial​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderDisplayFinancialStatus) An order's financial status for display in the Shopify admin. * display​Fulfillment​Status [Order​Display​Fulfillment​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderDisplayFulfillmentStatus) non-null The order's fulfillment status that displays in the Shopify admin to merchants. For example, an order might be unfulfilled or scheduled. For detailed processing, use the [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) object. * disputes [\[Order​Dispute​Summary!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderDisputeSummary) non-null A list of payment disputes associated with the order, such as chargebacks or payment inquiries. Disputes occur when customers challenge transactions with their bank or payment provider. * duties​Included [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether duties are included in the subtotal price of the order. Duties are import taxes charged by customs authorities when goods cross international borders. * edited [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order has had any edits applied. For example, adding or removing line items, updating quantities, or changing prices. * email [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The email address associated with the customer for this order. Used for sending order confirmations, shipping notifications, and other order-related communications. Returns `null` if no email address was provided during checkout. * estimated​Taxes [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether taxes on the order are estimated. This field returns `false` when taxes on the order are finalized and aren't subject to any changes. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null A list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation. * fulfillable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether there are line items that can be fulfilled. This field returns `false` when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. * fulfillment​Orders [Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderConnection) non-null A list of [fulfillment orders](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) for an order. Each fulfillment order groups [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.lineItems) that are fulfilled together, allowing an order to be processed in parts if needed. * fulfillments [\[Fulfillment!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Fulfillment) non-null A list of shipments for the order. Fulfillments represent the physical shipment of products to customers. * fulfillments​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The total number of fulfillments for the order, including canceled ones. * fully​Paid [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order has been paid in full. This field returns `true` when the total amount received equals or exceeds the order total. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the merchant has added a timeline comment to the order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * line​Items [Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LineItemConnection) non-null A list of the order's line items. Line items represent the individual products and quantities that make up the order. * localized​Fields [Localized​Field​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocalizedFieldConnection) non-null List of localized fields for the resource. * merchant​Business​Entity [Business​Entity!](https://shopify.dev/docs/api/admin-graphql/latest/objects/BusinessEntity) non-null The legal business structure that the merchant operates under for this order, such as an LLC, corporation, or partnership. Used for tax reporting, legal compliance, and determining which business entity is responsible for the order. * merchant​Editable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order can be edited by the merchant. Returns `false` for orders that can't be modified, such as canceled orders or orders with specific payment statuses. * merchant​Editable​Errors [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A list of reasons why the order can't be edited. For example, canceled orders can't be edited. * merchant​Of​Record​App [Order​App](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderApp) The application acting as the Merchant of Record for the order. The Merchant of Record is responsible for tax collection and remittance. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique identifier for the order that appears on the order page in the Shopify admin and the **Order status** page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. Use this field to identify orders in the Shopify admin and for order tracking. * net​Payment​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies. * non​Fulfillable​Line​Items [Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LineItemConnection) non-null A list of line items that can't be fulfilled. For example, tips and fully refunded line items can't be fulfilled. For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note associated with the order. Contains additional information or instructions added by merchants or customers during the order process. Commonly used for special delivery instructions, gift messages, or internal processing notes. * number [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The order number used to generate the name using the store's configured order number prefix/suffix. This number isn't guaranteed to follow a consecutive integer sequence (e.g. 1, 2, 3..), nor is it guaranteed to be unique across multiple stores, or even for a single store. * original​Total​Additional​Fees​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total amount of all additional fees, such as import fees or taxes, that were applied when an order was created. Returns `null` if additional fees aren't applicable. * original​Total​Duties​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total amount of duties calculated when an order was created, before any modifications. Modifications include returns, refunds, order edits, and cancellations. Use [`currentTotalDutiesSet`](https://shopify.dev/docs/api/admin-graphql/latest/objects/order#field-Order.fields.currentTotalDutiesSet) to retrieve the current duties amount after adjustments. * original​Total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order at the time of order creation, in shop and presentment currencies. Use this to compare the original order value against the current total after edits, returns, or refunds. * payment​Collection​Details [Order​Payment​Collection​Details!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderPaymentCollectionDetails) non-null The payment collection details for the order, including payment status, outstanding amounts, and collection information. Use this to understand when and how payments should be collected, especially for orders with deferred or installment payment terms. * payment​Gateway​Names [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)". * payment​Terms [Payment​Terms](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms) The payment terms associated with the order, such as net payment due dates or early payment discounts. Payment terms define when and how an order should be paid. Returns `null` if no specific payment terms were set for the order. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The phone number associated with the customer for this order. Useful for contacting customers about shipping updates, delivery notifications, or order issues. Returns `null` if no phone number was provided during checkout. * po​Number [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The purchase order (PO) number that's associated with an order. This is typically provided by business customers who require a PO number for their procurement. * presentment​Currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The currency used by the customer when placing the order. For example, "USD", "EUR", or "CAD". This may differ from the shop's base currency when serving international customers or using multi-currency pricing. * processed​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when the order was processed. This date and time might not match the date and time when the order was created. * product​Network [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer also purchased items from other stores in the network. * publication [Publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) The sales channel that the order was created from, such as the [Online Store](https://shopify.dev/docs/apps/build/app-surfaces#online-store) or [Shopify POS](https://shopify.dev/docs/apps/build/app-surfaces#point-of-sale). * purchasing​Entity [Purchasing​Entity](https://shopify.dev/docs/api/admin-graphql/latest/unions/PurchasingEntity) The business entity that placed the order, including company details and purchasing relationships. Used for B2B transactions to track which company or organization is responsible for the purchase and payment terms. * refundable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order can be refunded based on its payment transactions. Returns `false` for orders with no eligible payment transactions, such as fully refunded orders or orders with non-refundable payment methods. * refund​Discrepancy​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor. * refunds [\[Refund!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Refund) non-null A list of refunds that have been applied to the order. Refunds represent money returned to customers for returned items, cancellations, or adjustments. * registered​Source​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL of the source that the order originated from, if found in the domain registry. Returns `null` if the source URL isn't in the domain registry. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order requires physical shipping to the customer. Returns `false` for digital-only orders (such as gift cards or downloadable products) and `true` for orders with physical products that need delivery. Use this to determine shipping workflows and logistics requirements. * restockable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether any line items on the order can be restocked into inventory. Returns `false` for digital products, custom items, or items that can't be resold. * retail​Location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) The physical location where a retail order is created or completed, except for draft POS orders completed using the "mark as paid" flow in the Shopify admin, which return `null`. Transactions associated with the order might have been processed at a different location. * returns [Return​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReturnConnection) non-null The returns associated with the order. Contains information about items that customers have requested to return, including return reasons, status, and refund details. Use this to track and manage the return process for order items. * return​Status [Order​Return​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderReturnStatus) non-null The order's aggregated return status for display purposes. Indicates the overall state of returns for the order, helping merchants track and manage the return process. * risk [Order​Risk​Summary!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderRiskSummary) non-null The risk assessment summary for the order. Provides fraud analysis and risk scoring to help you identify potentially fraudulent orders. Use this to make informed decisions about order fulfillment and payment processing. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The shipping address where the order will be delivered. Contains the customer's delivery location for fulfillment and shipping label generation. Returns `null` for digital orders or orders that don't require shipping. * shipping​Line [Shipping​Line](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShippingLine) A summary of all shipping costs on the order. Aggregates shipping charges, discounts, and taxes to provide a single view of delivery costs. * shipping​Lines [Shipping​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ShippingLineConnection) non-null The shipping methods applied to the order. Each shipping line represents a shipping option chosen during checkout, including the carrier, service level, and cost. Use this to understand shipping charges and delivery options for the order. * shopify​Protect [Shopify​Protect​Order​Summary](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyProtectOrderSummary) The Shopify Protect details for the order, including fraud protection status and coverage information. Shopify Protect helps protect eligible orders against fraudulent chargebacks. Returns `null` if Shopify Protect is disabled for the shop or the order isn't eligible for protection. Learn more about [Shopify Protect](https://www.shopify.com/protect). * source​Identifier [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique POS or third party order identifier. For example, "1234-12-1000" or "111-98567-54". The [`receiptNumber`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-receiptNumber) field is derived from this value for POS orders. * source​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the source associated with the order, such as "web", "mobile\_app", or "pos". Use this field to identify the platform where the order was placed. * staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The staff member who created or is responsible for the order. Useful for tracking which team member handled phone orders, manual orders, or order modifications. Returns `null` for orders created directly by customers through the online store. * status​Page​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL where customers can check their order's current status, including tracking information and delivery updates. Provides order tracking links in emails, apps, or customer communications. * audience [Audience](https://shopify.dev/docs/api/admin-graphql/latest/enums/Audience) ### Arguments Specifies the intended audience for the status page URL. * notification​Usage [Notification​Usage](https://shopify.dev/docs/api/admin-graphql/latest/enums/NotificationUsage) Specifies the intended notification usage for the status page URL. *** * subtotal​Line​Items​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The sum of quantities for all line items that contribute to the order's subtotal price. This excludes quantities for items like tips, shipping costs, or gift cards that don't affect the subtotal. Use this to quickly understand the total item count for pricing calculations. * subtotal​Price​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. If `taxesIncluded` is `true`, then the subtotal also includes tax. * suggested​Refund [Suggested​Refund](https://shopify.dev/docs/api/admin-graphql/latest/objects/SuggestedRefund) A calculated refund suggestion for the order based on specified line items, shipping, and duties. Use this to preview refund amounts, taxes, and processing fees before creating an actual refund. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A comma separated list of tags associated with the order. Updating `tags` overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. * taxes​Included [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether taxes are included in the subtotal price of the order. When `true`, the subtotal and line item prices include tax amounts. When `false`, taxes are calculated and displayed separately. * tax​Exempt [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether taxes are exempt on the order. Returns `true` for orders where the customer or business has a valid tax exemption, such as non-profit organizations or tax-free purchases. Use this to understand if tax calculations were skipped during checkout. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of all tax lines applied to line items on the order, before returns. Tax line prices represent the total price for all tax lines with the same `rate` and `title`. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order can't be converted into a real order and vice versa. * total​Capturable​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns. * total​Cash​Rounding​Adjustment [Cash​Rounding​Adjustment!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CashRoundingAdjustment) non-null The total rounding adjustment applied to payments or refunds for an order involving cash payments. Applies to some countries where cash transactions are rounded to the nearest currency denomination. * total​Discounts​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts. * total​Outstanding​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount not yet transacted for the order, in shop and presentment currencies. A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer). * total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts. * total​Received​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount received from the customer before returns, in shop and presentment currencies. * total​Refunded​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount that was refunded, in shop and presentment currencies. * total​Refunded​Shipping​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount of shipping that was refunded, in shop and presentment currencies. * total​Shipping​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total shipping costs returned to the customer, in shop and presentment currencies. This includes fees and any related discounts that were refunded. * total​Tax​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total tax amount before returns, in shop and presentment currencies. * total​Tip​Received​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The sum of all tip amounts for the order, in shop and presentment currencies. * total​Weight [Unsigned​Int64](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) The total weight of the order before returns, in grams. * transactions [\[Order​Transaction!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction) non-null A list of transactions associated with the order. * transactions​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of transactions associated with the order. * unpaid [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether no payments have been made for the order. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) when the order was last modified. * cart​Discount​Amount [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) Deprecated * channel [Channel](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) Deprecated * customer​Journey [Customer​Journey](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerJourney) Deprecated * landing​Page​Display​Text [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * landing​Page​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Deprecated * localization​Extensions [Localization​Extension​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocalizationExtensionConnection) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * net​Payment [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * physical​Location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) Deprecated * referral​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * referrer​Display​Text [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * referrer​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Deprecated * risk​Level [Order​Risk​Level!](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderRiskLevel) non-nullDeprecated * risks [\[Order​Risk!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderRisk) non-nullDeprecated * subtotal​Price [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) Deprecated * total​Capturable [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Discounts [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) Deprecated * total​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Received [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Refunded [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Shipping​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Tax [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) Deprecated * total​Tip​Received [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-nullDeprecated * [Page](https://shopify.dev/docs/api/admin-graphql/latest/objects/Page) OBJECT A page on the Online Store. * body [HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) non-null The text content of the page, complete with HTML markup. * body​Summary [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time (ISO 8601 format) of the page creation. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * is​Published [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether or not the page is visible. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * published​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible. * template​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The suffix of the template that's used to render the page. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Title of the page. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time (ISO 8601 format) of the latest page update. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Payment​Customization](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentCustomization) OBJECT A payment customization. * enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null The enabled status of the payment customization. * error​History [Functions​Error​History](https://shopify.dev/docs/api/admin-graphql/latest/objects/FunctionsErrorHistory) The error history on the most recent version of the payment customization. * function​Id [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The ID of the Shopify Function implementing the payment customization. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * shopify​Function [Shopify​Function!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyFunction) non-null The Shopify Function implementing the payment customization. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the payment customization. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) OBJECT The `Product` object lets you manage products in a merchant’s store. Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use [product variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [media](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/collection). Learn more about working with [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components), including limitations and considerations. * available​Publications​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). * bundle​Components [Product​Bundle​Component​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductBundleComponentConnection) non-null A list of [components](https://shopify.dev/docs/apps/build/product-merchandising/bundles/add-product-fixed-bundle) that are associated with a product in a bundle. * category [Taxonomy​Category](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyCategory) The category of a product from [Shopify's Standard Product Taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17). * collections [Collection​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CollectionConnection) non-null A list of [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) that include the product. * combined​Listing [Combined​Listing](https://shopify.dev/docs/api/admin-graphql/latest/objects/CombinedListing) A special product type that combines separate products from a store into a single product listing. [Combined listings](https://shopify.dev/apps/build/product-merchandising/combined-listings) are connected by a shared option, such as color, model, or dimension. * combined​Listing​Role [Combined​Listings​Role](https://shopify.dev/docs/api/admin-graphql/latest/enums/CombinedListingsRole) The [role of the product](https://shopify.dev/docs/apps/build/product-merchandising/combined-listings/build-for-combined-listings) in a combined listing. If `null`, then the product isn't part of any combined listing. * compare​At​Price​Range [Product​Compare​At​Price​Range](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductCompareAtPriceRange) The [compare-at price range](https://help.shopify.com/manual/products/details/product-pricing/sale-pricing) of the product in the shop's default currency. * contextual​Pricing [Product​Contextual​Pricing!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductContextualPricing) non-null The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. Only active markets are considered in the price resolution. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the product was created. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. * description [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A single-line description of the product, with [HTML tags](https://developer.mozilla.org/en-US/docs/Web/HTML) removed. * truncate​At [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) ### Arguments Truncates a string after the given length. *** * description​Html [HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) non-null The description of the product, with HTML tags. For example, the description might include bold `` and italic `` text. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * featured​Media [Media](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Media) The featured [media](https://shopify.dev/docs/apps/build/online-store/product-media) associated with the product. * feedback [Resource​Feedback](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback) The information that lets merchants know what steps they need to take to make sure that the app is set up correctly. For example, if a merchant hasn't set up a product correctly in the app, then the feedback might include a message that says "You need to add a price to this product". * gift​Card​Template​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The [theme template](https://shopify.dev/docs/storefronts/themes/architecture/templates) that's used when customers view the gift card in a store. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique, human-readable string of the product's title. A handle can contain letters, hyphens (`-`), and numbers, but no spaces. The handle is used in the online store URL for the product. * has​Only​Default​Variant [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product has only a single variant with the default option and value. * has​Out​Of​Stock​Variants [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product has variants that are out of stock. * has​Variants​That​Requires​Components [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether at least one of the product variants requires [bundle components](https://shopify.dev/docs/apps/build/product-merchandising/bundles/add-product-fixed-bundle). Learn more about [store eligibility for bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles#store-eligibility). * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * in​Collection [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product is in a specified [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/collection). * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the collection to check. For example, `id: "gid://shopify/Collection/123"`. *** * is​Gift​Card [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product is a gift card. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * media [Media​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MediaConnection) non-null The [media](https://shopify.dev/docs/apps/build/online-store/product-media) associated with the product. Valid media are images, 3D models, videos. * media​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The total count of [media](https://shopify.dev/docs/apps/build/online-store/product-media) that's associated with a product. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * online​Store​Preview​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The [preview URL](https://help.shopify.com/manual/online-store/setting-up#preview-your-store) for the online store. * online​Store​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The product's URL on the online store. If `null`, then the product isn't published to the online store sales channel. * options [\[Product​Option!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption) non-null A list of product options. The limit is defined by the [shop's resource limits for product options](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-resourcelimits) (`Shop.resourceLimits.maxProductOptions`). * price​Range​V2 [Product​Price​Range​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductPriceRangeV2) non-null The minimum and maximum prices of a product, expressed in decimal numbers. For example, if the product is priced between $10.00 and $50.00, then the price range is $10.00 - $50.00. * product​Components [Product​Component​Type​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductComponentTypeConnection) non-null A list of products that contain at least one variant associated with at least one of the current products' variants via group relationship. * product​Components​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) A count of unique products that contain at least one variant associated with at least one of the current products' variants via group relationship. * product​Parents [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-null A list of products that has a variant that contains any of this product's variants as a component. * product​Type [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The [product type](https://help.shopify.com/manual/products/details/product-type) that merchants define. * published​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the product was published to the online store. * published​In​Context [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location. * context [Contextual​Publication​Context!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/ContextualPublicationContext) required ### Arguments The context used to determine publication status. *** * published​On​Current​Publication [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the resource is published to the app's [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). For example, the resource might be published to the app's online store channel. * published​On​Publication [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the resource is published to a specified [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). * publication​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the publication to check. For example, `id: "gid://shopify/Publication/123"`. *** * requires​Selling​Plan [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product can only be purchased with a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans). Products that are sold on subscription (`requiresSellingPlan: true`) can be updated only for online stores. If you update a product to be subscription-only (`requiresSellingPlan:false`), then the product is unpublished from all channels, except the online store. * resource​Publication​On​Current​Publication [Resource​Publication​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourcePublicationV2) The resource that's either published or staged to be published to the [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). * resource​Publications [Resource​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection) non-null The list of resources that are published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). * resource​Publications​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback). * resource​Publications​V2 [Resource​Publication​V2Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationV2Connection) non-null The list of resources that are either published or staged to be published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). * restricted​For​Resource [Restricted​For​Resource](https://shopify.dev/docs/api/admin-graphql/latest/objects/RestrictedForResource) Whether the merchant can make changes to the product when they [edit the order](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders) associated with the product. For example, a merchant might be restricted from changing product details when they edit an order. * selling​Plan​Groups [Selling​Plan​Group​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SellingPlanGroupConnection) non-null A list of all [selling plan groups](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan) that are associated with the product either directly, or through the product's variants. * selling​Plan​Groups​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) A count of [selling plan groups](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan) that are associated with the product. * seo [SEO!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SEO) non-null The [SEO title and description](https://help.shopify.com/manual/promoting-marketing/seo/adding-keywords) that are associated with a product. * status [Product​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductStatus) non-null The [product status](https://help.shopify.com/manual/products/details/product-details-page#product-status), which controls visibility across all sales channels. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the `sports` and `summer` tags to products that are associated with sportwear for summer. Updating `tags` overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the [`tagsAdd`](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. * template​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The [theme template](https://shopify.dev/docs/storefronts/themes/architecture/templates) that's used when customers view the product in a store. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is `black-sunglasses`. * total​Inventory [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of inventory that's in stock. * tracks​Inventory [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether [inventory tracking](https://help.shopify.com/manual/products/inventory/getting-started-with-inventory/set-up-inventory-tracking) has been enabled for the product. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * unpublished​Publications [Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PublicationConnection) non-null The list of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that the resource isn't published to. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the product was last modified. A product's `updatedAt` value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update. * variants [Product​Variant​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductVariantConnection) non-null A list of [variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) associated with the product. If querying a single product at the root, you can fetch up to 2048 variants. * variants​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of [variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) that are associated with the product. * vendor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the product's vendor. * body​Html [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * custom​Product​Type [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * description​Plain​Summary [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-nullDeprecated * featured​Image [Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) Deprecated * images [Image​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ImageConnection) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * price​Range [Product​Price​Range!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductPriceRange) non-nullDeprecated * product​Category [Product​Category](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductCategory) Deprecated * product​Publications [Product​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductPublicationConnection) non-nullDeprecated * publication​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * only​Published [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:true ### Arguments Include only the resource's publications that are published. If false, then return all the resource's publications including future publications. *** * publications [Product​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductPublicationConnection) non-nullDeprecated * published​On​Channel [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * channel​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the channel to check. *** * published​On​Current​Channel [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * selling​Plan​Group​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * standardized​Product​Type [Standardized​Product​Type](https://shopify.dev/docs/api/admin-graphql/latest/objects/StandardizedProductType) Deprecated * storefront​Id [Storefront​ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/StorefrontID) non-nullDeprecated * total​Variants [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * unpublished​Channels [Channel​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ChannelConnection) non-nullDeprecated * [Product​Variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) OBJECT The `ProductVariant` object represents a version of a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) that comes in more than one [option](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption), such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another. Use the `ProductVariant` object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the `ProductVariant` object include: * Tracking inventory for each variant * Setting unique prices for each variant * Assigning barcodes and SKUs to connect variants to fulfillment services * Attaching variant-specific images and media * Setting delivery and tax requirements * Supporting product bundles, subscriptions, and selling plans A `ProductVariant` is associated with a parent [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) object. `ProductVariant` serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as: * [`InventoryItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem): Used for inventory tracking * [`Image`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image): Used for variant-specific images * [`SellingPlanGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanGroup): Used for subscriptions and selling plans Learn more about [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components). * available​For​Sale [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product variant is available for sale. * barcode [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The value of the barcode associated with the product. * compare​At​Price [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) The compare-at price of the variant in the default shop currency. * contextual​Pricing [Product​Variant​Contextual​Pricing!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariantContextualPricing) non-null The pricing that applies for a customer in a given context. As of API version 2025-04, only active markets are considered in the price resolution. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the variant was created. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID. * delivery​Profile [Delivery​Profile](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfile) The [delivery profile](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryProfile) for the variant. * display​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Display name of the variant, based on product's title + variant's title. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the host subject. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * inventory​Item [Inventory​Item!](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) non-null The inventory item, which is used to query for inventory information. * inventory​Policy [Product​Variant​Inventory​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductVariantInventoryPolicy) non-null Whether customers are allowed to place an order for the product variant when it's out of stock. * inventory​Quantity [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The total sellable quantity of the variant. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * media [Media​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MediaConnection) non-null The media associated with the product variant. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * position [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The order of the product variant in the list of product variants. The first position in the list is 1. * price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-null The price of the product variant in the default shop currency. * product [Product!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) non-null The product that this variant belongs to. * product​Parents [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-null A list of products that have product variants that contain this variant as a product component. * product​Variant​Components [Product​Variant​Component​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductVariantComponentConnection) non-null A list of the product variant components. * requires​Components [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether a product variant requires components. The default value is `false`. If `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles. * selected​Options [\[Selected​Option!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SelectedOption) non-null List of product options applied to the variant. * sellable​Online​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture [limitations based on customer location](https://help.shopify.com/manual/markets/inventory_and_fulfillment). * selling​Plan​Groups [Selling​Plan​Group​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SellingPlanGroupConnection) non-null A list of all selling plan groups defined in the current shop associated with the product variant. * selling​Plan​Groups​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) Count of selling plan groups associated with the product variant. * show​Unit​Price [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether to show the unit price for this product variant. * sku [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service. * taxable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether a tax is charged when the product variant is sold. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the product variant. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * unit​Price [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The unit price value for the variant based on the variant measurement. * unit​Price​Measurement [Unit​Price​Measurement](https://shopify.dev/docs/api/admin-graphql/latest/objects/UnitPriceMeasurement) The unit price measurement for the variant. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time (ISO 8601 format) when the product variant was last modified. * image [Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) Deprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * presentment​Prices [Product​Variant​Price​Pair​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductVariantPricePairConnection) non-nullDeprecated * selling​Plan​Group​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * storefront​Id [Storefront​ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/StorefrontID) non-nullDeprecated * tax​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [Shop](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop) OBJECT Represents a collection of general settings and information about the shop. * account​Owner [Staff​Member!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) non-null Account owner information. * alerts [\[Shop​Alert!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAlert) non-null A list of the shop's active alert messages that appear in the Shopify admin. * all​Product​Categories​List [\[Taxonomy​Category!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyCategory) non-null A list of the shop's product categories. Limit: 1000 product categories. * available​Channel​Apps [App​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/AppConnection) non-null The list of sales channels not currently installed on the shop. * billing​Address [Shop​Address!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress) non-null The shop's billing address information. * channel​Definitions​For​Installed​Channels [\[Available​Channel​Definitions​By​Channel!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AvailableChannelDefinitionsByChannel) non-null List of all channel definitions associated with a shop. * checkout​Api​Supported [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Specifies whether the shop supports checkouts via Checkout API. * contact​Email [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner. * countries​In​Shipping​Zones [Countries​In​Shipping​Zones!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CountriesInShippingZones) non-null Countries that have been defined in shipping zones for the shop. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the shop was created. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The three letter code for the currency that the shop sells in. * currency​Formats [Currency​Formats!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CurrencyFormats) non-null How currencies are displayed on your store. * currency​Settings [Currency​Setting​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CurrencySettingConnection) non-null The presentment currency settings for the shop excluding the shop's own currency. * customer​Accounts [Shop​Customer​Accounts​Setting!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopCustomerAccountsSetting) non-null Whether customer accounts are required, optional, or disabled for the shop. * customer​Accounts​V2 [Customer​Accounts​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerAccountsV2) non-null Information about the shop's customer accounts. * customer​Tags [String​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StringConnection) non-null A list of tags that have been added to customer accounts. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The shop's meta description used in search engine results. * draft​Order​Tags [String​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StringConnection) non-null A list of tags that have been added to draft orders. * email [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The shop owner's email address. Shopify will use this email address to communicate with the shop owner. * enabled​Presentment​Currencies [\[Currency​Code!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The presentment currencies enabled for the shop. * entitlements [Entitlements​Type!](https://shopify.dev/docs/api/admin-graphql/latest/objects/EntitlementsType) non-null The entitlements for a shop. * features [Shop​Features!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopFeatures) non-null The set of features enabled for the shop. * fulfillment​Services [\[Fulfillment​Service!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) non-null List of the shop's installed fulfillment services. * iana​Timezone [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The shop's time zone as defined by the IANA. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * marketing​Sms​Consent​Enabled​At​Checkout [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether SMS marketing has been enabled on the shop's checkout configuration settings. * merchant​Approval​Signals [Merchant​Approval​Signals](https://shopify.dev/docs/api/admin-graphql/latest/objects/MerchantApprovalSignals) The approval signals for a shop to support onboarding to channel apps. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * myshopify​Domain [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The shop's .myshopify.com domain name. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The shop's name. * navigation​Settings [\[Navigation​Item!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/NavigationItem) non-null The shop's settings related to navigation. * order​Number​Format​Prefix [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The prefix that appears before order numbers. * order​Number​Format​Suffix [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The suffix that appears after order numbers. * order​Tags [String​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StringConnection) non-null A list of tags that have been added to orders. * payment​Settings [Payment​Settings!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentSettings) non-null The shop's settings related to payments. * plan [Shop​Plan!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopPlan) non-null The shop's billing plan. * primary​Domain [Domain!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Domain) non-null The primary domain of the shop's online store. * resource​Limits [Shop​Resource​Limits!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopResourceLimits) non-null The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed. * rich​Text​Editor​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL of the rich text editor that can be used for mobile devices. * search [Search​Result​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SearchResultConnection) non-null Fetches a list of admin search results by a specified query. * search​Filters [Search​Filter​Options!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SearchFilterOptions) non-null The list of search filter options for the shop. These can be used to filter productvisibility for the shop. * setup​Required [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the shop has outstanding setup steps. * ships​To​Countries [\[Country​Code!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) non-null The list of countries that the shop ships to. * shop​Owner​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the shop owner. * shop​Policies [\[Shop​Policy!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopPolicy) non-null The list of all legal policies associated with a shop. * storefront​Access​Tokens [Storefront​Access​Token​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StorefrontAccessTokenConnection) non-null The storefront access token of a private application. These are scoped per-application. * taxes​Included [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether applicable taxes are included in the shop's product prices. * tax​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the shop charges taxes for shipping. * timezone​Abbreviation [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The shop's time zone abbreviation. * timezone​Offset [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The shop's time zone offset. * timezone​Offset​Minutes [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The shop's time zone offset expressed as a number of minutes. * transactional​Sms​Disabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether transactional SMS sent by Shopify have been disabled for a shop. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * unit​System [Unit​System!](https://shopify.dev/docs/api/admin-graphql/latest/enums/UnitSystem) non-null The shop's unit system for weights and measures. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the shop was last updated. * url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL of the shop's online store. * weight​Unit [Weight​Unit!](https://shopify.dev/docs/api/admin-graphql/latest/enums/WeightUnit) non-null The shop's primary unit of weight for products and shipping. * all​Product​Categories [\[Product​Category!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductCategory) non-nullDeprecated * analytics​Token [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-nullDeprecated * assigned​Fulfillment​Orders [Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderConnection) non-nullDeprecated * channels [Channel​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ChannelConnection) non-nullDeprecated * collections [Collection​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CollectionConnection) non-nullDeprecated * customers [Customer​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CustomerConnection) non-nullDeprecated * domains [\[Domain!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Domain) non-nullDeprecated * draft​Orders [Draft​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DraftOrderConnection) non-nullDeprecated (removal date set) * fulfillment​Orders [Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderConnection) non-nullDeprecated * inventory​Items [Inventory​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/InventoryItemConnection) non-nullDeprecated * limited​Pending​Order​Count [Limited​Pending​Order​Count!](https://shopify.dev/docs/api/admin-graphql/latest/objects/LimitedPendingOrderCount) non-nullDeprecated * locations [Location​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocationConnection) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * orders [Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderConnection) non-nullDeprecated * product​Images [Image​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ImageConnection) non-nullDeprecated * products [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-nullDeprecated * product​Tags [String​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StringConnection) non-nullDeprecated * product​Types [String​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StringConnection) non-nullDeprecated * product​Variants [Product​Variant​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductVariantConnection) non-nullDeprecated * product​Vendors [String​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StringConnection) non-nullDeprecated * publication​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * staff​Members [Staff​Member​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StaffMemberConnection) non-nullDeprecated * storefront​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-nullDeprecated *** ## Fields with this union * [Metafield​Relation.referencer](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldRelation#field-MetafieldRelation.fields.referencer) OBJECT Defines a relation between two resources via a reference metafield. The referencer owns the joining field with a given namespace and key, while the target is referenced by the field. *** ```graphql union MetafieldReferencer = AppInstallation | Article | Blog | Collection | Company | CompanyLocation | Customer | DeliveryCustomization | DiscountAutomaticNode | DiscountCodeNode | DiscountNode | DraftOrder | FulfillmentOrder | Location | Market | Metaobject | Order | Page | PaymentCustomization | Product | ProductVariant | Shop ```