--- title: Node - GraphQL Admin description: |- An object with an ID field to support global identification, in accordance with the [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. api_version: 2025-10 api_name: admin type: interface api_type: graphql source_url: html: https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node md: https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node.md --- # Node interface An object with an ID field to support global identification, in accordance with the [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. ## Fields * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. *** ## Types implemented in * [Abandoned​Checkout](https://shopify.dev/docs/api/admin-graphql/latest/objects/AbandonedCheckout) OBJECT A checkout that was abandoned by the customer. * abandoned​Checkout​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL for the buyer to recover their checkout. * billing​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The billing address provided by the buyer. Null if the user did not provide a billing address. * completed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the buyer completed the checkout. Null if the checkout has not been completed. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the checkout was created. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of extra information that has been added to the checkout. * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer who created this checkout. May be null if the checkout was created from a draft order or via an app. * 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 The discount codes entered by the buyer at checkout. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Items [Abandoned​Checkout​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/AbandonedCheckoutLineItemConnection) non-null A list of the line items in this checkout. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Unique merchant-facing identifier for the checkout. * note [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A merchant-facing note added to the checkout. Not visible to the buyer. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The shipping address to where the line items will be shipped. Null if the user did not provide a shipping address. * subtotal​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The sum of all items in the checkout, including discounts but excluding shipping, taxes and tips. * taxes​Included [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether taxes are included in line item and shipping line prices. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null Individual taxes charged on the checkout. * total​Discount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount of discounts to be applied. * total​Duties​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total duties applied to the checkout. * total​Line​Items​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The sum of the prices of all line items in the checkout. * total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The sum of all items in the checkout, including discounts, shipping, taxes, and tips. * total​Tax​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The total tax applied to the checkout. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the checkout was most recently updated. * line​Items​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * [Abandoned​Checkout​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/AbandonedCheckoutLineItem) OBJECT A single line item in an abandoned checkout. * components [\[Abandoned​Checkout​Line​Item​Component!\]](https://shopify.dev/docs/api/admin-graphql/latest/objects/AbandonedCheckoutLineItemComponent) A list of line item components for this line item. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of extra information that has been added to the line item. * discount​Allocations [Discount​Allocation​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DiscountAllocationConnection) non-null Discount allocations that have been applied on the line item. * discounted​Total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null Final total price for the entire quantity of this line item, including discounts. * discounted​Total​Price​With​Code​Discount [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price for the entire quantity of this line item, after all discounts are applied, at both the line item and code-based line item level. * discounted​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The price of a single variant unit after discounts are applied at the line item level, in shop and presentment currencies. * discounted​Unit​Price​With​Code​Discount [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The price of a single variant unit after all discounts are applied, at both the line item and code-based line item level. * 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 line item's variant or product. NULL if the line item has no product, or if neither the variant nor the product have an image. * original​Total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null Original total price for the entire quantity of this line item, before discounts. * original​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null Original price for a single unit of this line item, before discounts. * parent​Relationship [Abandoned​Checkout​Line​Item​Parent​Relationship](https://shopify.dev/docs/api/admin-graphql/latest/objects/AbandonedCheckoutLineItemParentRelationship) The parent relationship for this line item. * product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) Product for this line item. NULL for custom line items and products that were deleted after checkout began. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the line item. * sku [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) SKU for the inventory item associated with the variant, if any. * title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Title of the line item. Defaults to the product's title. * variant [Product​Variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) Product variant for this line item. NULL for custom line items and variants that were deleted after checkout began. * variant​Title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Title of the variant for this line item. NULL for custom line items and products that don't have distinct variants. * [Abandonment](https://shopify.dev/docs/api/admin-graphql/latest/objects/Abandonment) OBJECT A browse, cart, or checkout that was abandoned by a customer. * abandoned​Checkout​Payload [Abandoned​Checkout](https://shopify.dev/docs/api/admin-graphql/latest/objects/AbandonedCheckout) The abandonment payload for the abandoned checkout. * abandonment​Type [Abandonment​Abandonment​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/AbandonmentAbandonmentType) non-null The abandonment type. * app [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The app associated with an abandoned checkout. * cart​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Permalink to the cart page. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the abandonment was created. * customer [Customer!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) non-null The customer who abandoned this event. * customer​Has​No​Draft​Order​Since​Abandonment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer has a draft order since this abandonment has been abandoned. * customer​Has​No​Order​Since​Abandonment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer has completed an order since this checkout has been abandoned. * days​Since​Last​Abandonment​Email [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of days since the last abandonment email was sent to the customer. * email​Sent​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) When the email was sent, if that's the case. * email​State [Abandonment​Email​State](https://shopify.dev/docs/api/admin-graphql/latest/enums/AbandonmentEmailState) The email state (e.g., sent or not sent). * hours​Since​Last​Abandoned​Checkout [Float](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) The number of hours since the customer has last abandoned a checkout. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * inventory​Available [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the products in abandonment are available. * is​From​Custom​Storefront [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the abandonment event comes from a custom storefront channel. * is​From​Online​Store [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the abandonment event comes from the Online Store sales channel. * is​From​Shop​App [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the abandonment event comes from the Shop app sales channel. * is​From​Shop​Pay [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the abandonment event comes from Shop Pay. * is​Most​Significant​Abandonment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the customer didn't complete another most significant step since this abandonment. * last​Browse​Abandonment​Date [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date for the latest browse abandonment. * last​Cart​Abandonment​Date [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date for the latest cart abandonment. * last​Checkout​Abandonment​Date [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date for the latest checkout abandonment. * most​Recent​Step [Abandonment​Abandonment​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/AbandonmentAbandonmentType) non-null The most recent step type. * products​Added​To​Cart [Customer​Visit​Product​Info​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CustomerVisitProductInfoConnection) non-null The products added to the cart during the customer abandoned visit. * products​Viewed [Customer​Visit​Product​Info​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CustomerVisitProductInfoConnection) non-null The products viewed during the customer abandoned visit. * visit​Started​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the visit started. * [Add​All​Products​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/AddAllProductsOperation) OBJECT Represents an operation publishing all products to a publication. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * processed​Row​Count [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The count of processed rows, summing imported, failed, and skipped rows. * row​Count [Row​Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/RowCount) Represents a rows objects within this background operation. * status [Resource​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ResourceOperationStatus) non-null The status of this operation. * [Additional​Fee](https://shopify.dev/docs/api/admin-graphql/latest/objects/AdditionalFee) OBJECT The additional fees that have been applied to the order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the additional fee. * price [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The price of the additional fee. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of taxes charged on the additional fee. * [App](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) OBJECT A Shopify application. * api​Key [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique application API identifier. * app​Store​App​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) App store page URL of the app. * app​Store​Developer​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) App store page URL of the developer who created the app. * available​Access​Scopes [\[Access​Scope!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) non-null All requestable access scopes available to the app. * banner [Image!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) non-null Banner image for the app. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Description of the app. * developer​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the app developer. * developer​Type [App​Developer​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppDeveloperType) non-null The type of app developer. * embedded [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the app uses the Embedded App SDK. * failed​Requirements [\[Failed​Requirement!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FailedRequirement) non-null Requirements that must be met before the app can be installed. * features [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A list of app features that are shown in the Shopify App Store listing. * feedback [App​Feedback](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppFeedback) Feedback from this app about the store. * handle [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Handle of the app. * icon [Image!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) non-null Icon that represents the app. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * installation [App​Installation](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation) Corresponding AppInstallation for this shop and App. Returns null if the App is not installed. * install​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Webpage where you can install the app, if app requires explicit user permission. * is​Post​Purchase​App​In​Use [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use. * optional​Access​Scopes [\[Access​Scope!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) non-null The optional scopes requested by the app. Lists the optional access scopes the app has declared in its configuration. These scopes are optionally requested by the app after installation. * previously​Installed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the app was previously installed on the current shop. * pricing​Details [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Detailed information about the app pricing. * pricing​Details​Summary [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Summary of the app pricing details. * privacy​Policy​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Link to app privacy policy. * public​Category [App​Public​Category!](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppPublicCategory) non-null The public category for the app. * published [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the app is published to the Shopify App Store. * requested​Access​Scopes [\[Access​Scope!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) non-null The access scopes requested by the app. Lists the access scopes the app has declared in its configuration. Merchant must grant approval to these scopes for the app to be installed. * screenshots [\[Image!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) non-null Screenshots of the app. * shopify​Developed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the app was developed by Shopify. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Name of the app. * uninstall​Message [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Message that appears when the app is uninstalled. For example: By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time. * webhook​Api​Version [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The webhook API version for the app. * developer​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-nullDeprecated * launch​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-nullDeprecated * navigation​Items [\[Navigation​Item!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/NavigationItem) non-nullDeprecated * uninstall​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Deprecated * [App​Catalog](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppCatalog) OBJECT A catalog that defines the publication associated with an app. * apps [App​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/AppConnection) non-null The apps associated with the catalog. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * operations [\[Resource​Operation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/ResourceOperation) non-null Most recent catalog operations. * price​List [Price​List](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) The price list associated with the catalog. * publication [Publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) A group of products and collections that's published to a catalog. * status [Catalog​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CatalogStatus) non-null The status of the catalog. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the catalog. * [App​Credit](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppCredit) OBJECT Represents monetary credits that merchants can apply toward future app purchases, subscriptions, or usage-based billing within their Shopify store. App credits provide a flexible way to offer refunds, promotional credits, or compensation without processing external payments. For example, if a merchant experiences service downtime, an app might issue credits equivalent to the affected billing period. These credits can apply to future charges, reducing the merchant's next invoice or extending their subscription period. Use the `AppCredit` object to: * Issue refunds for service interruptions or billing disputes * Provide promotional credits for new merchant onboarding * Compensate merchants for app-related issues or downtime * Create loyalty rewards or referral bonuses within your billing system * Track credit balances and application history for accounting purposes For comprehensive billing strategies and credit management patterns, see the [subscription billing guide](https://shopify.dev/docs/apps/launch/billing/subscription-billing). * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount that can be used towards future app purchases in Shopify. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the app credit was created. * description [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The description of the app credit. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the app credit is a test transaction. * [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 * [App​Purchase​One​Time](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppPurchaseOneTime) OBJECT Represents a one-time purchase of app services or features by a merchant, tracking the transaction details and status throughout the billing lifecycle. This object captures essential information about non-recurring charges, including price and merchant acceptance status. One-time purchases are particularly valuable for apps offering premium features, professional services, or digital products that don't require ongoing subscriptions. For instance, a photography app might sell premium filters as one-time purchases, while a marketing app could charge for individual campaign setups or advanced analytics reports. Use the `AppPurchaseOneTime` object to: * Track the status of individual feature purchases and service charges * Track payment status for premium content or digital products * Access purchase details to enable or disable features based on payment status The purchase status indicates whether the charge is pending merchant approval, has been accepted and processed, or was declined. This status tracking is crucial for apps that need to conditionally enable features based on successful payment completion. Purchase records include creation timestamps, pricing details, and test flags to distinguish between production charges and development testing. The test flag ensures that development and staging environments don't generate actual charges while maintaining realistic billing flow testing. For detailed implementation patterns and billing best practices, see the [one-time-charges page](https://shopify.dev/docs/apps/launch/billing/one-time-charges). * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the app purchase occurred. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the app purchase. * price [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount to be charged to the store for the app purchase. * status [App​Purchase​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppPurchaseStatus) non-null The status of the app purchase. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the app purchase is a test transaction. * [App​Revenue​Attribution​Record](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppRevenueAttributionRecord) OBJECT Tracks revenue that was captured outside of Shopify's billing system but needs to be attributed to the app for comprehensive revenue reporting and partner analytics. This object enables accurate revenue tracking when apps process payments through external systems while maintaining visibility into total app performance. External revenue attribution is essential for apps that offer multiple payment channels or process certain transactions outside Shopify's billing infrastructure. For example, an enterprise app might process large custom contracts through external payment processors, or a marketplace app could handle direct merchant-to-merchant transactions that still generate app commissions. Use the `AppRevenueAttributionRecord` object to: * Report revenue from external payment processors and billing systems * Track commission-based earnings from marketplace or referral activities * Maintain comprehensive revenue analytics across multiple payment channels * Ensure accurate partner revenue sharing and commission calculations * Generate complete financial reports that include all app-generated revenue streams * Support compliance requirements for external revenue documentation Each attribution record includes the captured amount, external transaction timestamp, and idempotency keys to prevent duplicate reporting. The record type field categorizes different revenue streams, enabling detailed analytics and reporting segmentation. Revenue attribution records are particularly important for apps participating in Shopify's partner program, as they ensure accurate revenue sharing calculations and comprehensive performance metrics. The captured timestamp reflects when the external payment was processed, not when the attribution record was created in Shopify. For detailed revenue attribution values, see the [AppRevenueAttributionType enum](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppRevenueAttributionType). * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The financial amount captured in this attribution. * captured​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The timestamp when the financial amount was captured. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The timestamp at which this revenue attribution was issued. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * idempotency​Key [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique value submitted during the creation of the app revenue attribution record. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Indicates whether this is a test submission. * type [App​Revenue​Attribution​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppRevenueAttributionType) non-null The type of revenue attribution. * [App​Subscription](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) OBJECT Provides users access to services and/or features for a duration of time. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the app subscription was created. * current​Period​End [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the current app subscription period ends. Returns `null` if the subscription isn't active. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Items [\[App​Subscription​Line​Item!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscriptionLineItem) non-null The plans attached to the app subscription. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the app subscription. * return​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL that the merchant is redirected to after approving the app subscription. * status [App​Subscription​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppSubscriptionStatus) non-null The status of the app subscription. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Specifies whether the app subscription is a test transaction. * trial​Days [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of free trial days, starting at the subscription's creation date, by which billing is delayed. * [App​Usage​Record](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppUsageRecord) OBJECT Store usage for app subscriptions with usage pricing. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the usage record was created. * description [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The description of the app usage record. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * idempotency​Key [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique key generated by the client to avoid duplicate charges. * price [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The price of the usage record. * subscription​Line​Item [App​Subscription​Line​Item!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscriptionLineItem) non-null Defines the usage pricing plan the merchant is subscribed to. * [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 * [Basic​Event](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent) OBJECT Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product. ### General events | Action | Description | | - | - | | `create` | The item was created. | | `destroy` | The item was destroyed. | | `published` | The item was published. | | `unpublished` | The item was unpublished. | | `update` | The item was updated. | ### Order events Order events can be divided into the following categories: * *Authorization*: Includes whether the authorization succeeded, failed, or is pending. * *Capture*: Includes whether the capture succeeded, failed, or is pending. * *Email*: Includes confirmation or cancellation of the order, as well as shipping. * *Fulfillment*: Includes whether the fulfillment succeeded, failed, or is pending. Also includes cancellation, restocking, and fulfillment updates. * *Order*: Includess the placement, confirmation, closing, re-opening, and cancellation of the order. * *Refund*: Includes whether the refund succeeded, failed, or is pending. * *Sale*: Includes whether the sale succeeded, failed, or is pending. * *Void*: Includes whether the void succeeded, failed, or is pending. | Action | Message | Description | | - | - | - | | `authorization_failure` | The customer, unsuccessfully, tried to authorize: `{money_amount}`. | Authorization failed. The funds cannot be captured. | | `authorization_pending` | Authorization for `{money_amount}` is pending. | Authorization pending. | | `authorization_success` | The customer successfully authorized us to capture: `{money_amount}`. | Authorization was successful and the funds are available for capture. | | `cancelled` | Order was cancelled by `{shop_staff_name}`. | The order was cancelled. | | `capture_failure` | We failed to capture: `{money_amount}`. | The capture failed. The funds cannot be transferred to the shop. | | `capture_pending` | Capture for `{money_amount}` is pending. | The capture is in process. The funds are not yet available to the shop. | | `capture_success` | We successfully captured: `{money_amount}` | The capture was successful and the funds are now available to the shop. | | `closed` | Order was closed. | The order was closed. | | `confirmed` | Received a new order: `{order_number}` by `{customer_name}`. | The order was confirmed. | | `fulfillment_cancelled` | We cancelled `{number_of_line_items}` from being fulfilled by the third party fulfillment service. | Fulfillment for one or more of the line\_items failed. | | `fulfillment_pending` | We submitted `{number_of_line_items}` to the third party service. | One or more of the line\_items has been assigned to a third party service for fulfillment. | | `fulfillment_success` | We successfully fulfilled line\_items. | Fulfillment was successful for one or more line\_items. | | `mail_sent` | `{message_type}` email was sent to the customer. | An email was sent to the customer. | | `placed` | Order was placed. | An order was placed by the customer. | | `re_opened` | Order was re-opened. | An order was re-opened. | | `refund_failure` | We failed to refund `{money_amount}`. | The refund failed. The funds are still with the shop. | | `refund_pending` | Refund of `{money_amount}` is still pending. | The refund is in process. The funds are still with shop. | | `refund_success` | We successfully refunded `{money_amount}`. | The refund was successful. The funds have been transferred to the customer. | | `restock_line_items` | We restocked `{number_of_line_items}`. | One or more of the order's line items have been restocked. | | `sale_failure` | The customer failed to pay `{money_amount}`. | The sale failed. The funds are not available to the shop. | | `sale_pending` | The `{money_amount}` is pending. | The sale is in process. The funds are not yet available to the shop. | | `sale_success` | We successfully captured `{money_amount}`. | The sale was successful. The funds are now with the shop. | | `update` | `{order_number}` was updated. | The order was updated. | | `void_failure` | We failed to void the authorization. | Voiding the authorization failed. The authorization is still valid. | | `void_pending` | Authorization void is pending. | Voiding the authorization is in process. The authorization is still valid. | | `void_success` | We successfully voided the authorization. | Voiding the authorization was successful. The authorization is no longer valid. | * action [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The action that occured. * additional​Content [JSON](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) Provides additional content for collapsible timeline events. * additional​Data [JSON](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) Provides additional data for event consumers. * app​Title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the app that created the event. * arguments [JSON](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) Refers to a certain event and its resources. * attribute​To​App [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the event was created by an app. * attribute​To​User [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the event was caused by an admin user. * author [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The entity which performed the action that generated the event. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the event was created. * critical​Alert [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the event is critical. * has​Additional​Content [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this event has additional content. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * message [Formatted​String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/FormattedString) non-null Human readable text that describes the event. * secondary​Message [Formatted​String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/FormattedString) Human readable text that supports the event message. * subject [Has​Events](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasEvents) The resource that generated the event. To see a list of possible types, refer to [HasEvents](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/HasEvents#implemented-in). * subject​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of the resource that generated the event. * subject​Type [Event​Subject​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/EventSubjectType) non-null The type of the resource that generated the event. * [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 * [Bulk​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/BulkOperation) OBJECT An asynchronous long-running operation to fetch data in bulk or to bulk import data. Bulk operations are created using the `bulkOperationRunQuery` or `bulkOperationRunMutation` mutation. After they are created, clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains a link to the data in [JSONL](http://jsonlines.org/) format. Refer to the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details. * completed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) When the bulk operation was successfully completed. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null When the bulk operation was created. * error​Code [Bulk​Operation​Error​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/BulkOperationErrorCode) Error code for failed operations. * file​Size [Unsigned​Int64](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) File size in bytes of the file in the `url` field. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * object​Count [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null A running count of all the objects processed. For example, when fetching all the products and their variants, this field counts both products and variants. This field can be used to track operation progress. * partial​Data​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL that points to the partial or incomplete response data (in [JSONL](http://jsonlines.org/) format) that was returned by a failed operation. The URL expires 7 days after the operation fails. Returns `null` when there's no data available. * query [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null GraphQL query document specified in `bulkOperationRunQuery`. * root​Object​Count [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null A running count of all the objects that are processed at the root of the query. For example, when fetching all the products and their variants, this field only counts products. This field can be used to track operation progress. * status [Bulk​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/BulkOperationStatus) non-null Status of the bulk operation. * type [Bulk​Operation​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/BulkOperationType) non-null The bulk operation's type. * url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL that points to the response data in [JSONL](http://jsonlines.org/) format. The URL expires 7 days after the operation completes. * [Business​Entity](https://shopify.dev/docs/api/admin-graphql/latest/objects/BusinessEntity) OBJECT Represents a merchant's Business Entity. * address [Business​Entity​Address!](https://shopify.dev/docs/api/admin-graphql/latest/objects/BusinessEntityAddress) non-null The address of the merchant's Business Entity. * archived [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the Business Entity is archived from the shop. * company​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the company associated with the merchant's Business Entity. * display​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The display name of the merchant's Business Entity. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * primary [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether it's the merchant's primary Business Entity. * shopify​Payments​Account [Shopify​Payments​Account](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsAccount) Shopify Payments account information, including balances and payouts. * [Calculated​Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/CalculatedOrder) OBJECT An order with edits applied but not saved. * added​Discount​Applications [Calculated​Discount​Application​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CalculatedDiscountApplicationConnection) non-null Returns only the new discount applications being added to the order in the current edit. * added​Line​Items [Calculated​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CalculatedLineItemConnection) non-null Returns only the new line items being added to the order during the current edit. * cart​Discount​Amount​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) Amount of the order-level discount (doesn't contain any line item discounts) in shop and presentment currencies. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Items [Calculated​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CalculatedLineItemConnection) non-null Returns all items on the order that existed before starting the edit. Will include any changes that have been made. Will not include line items added during the current edit. * notification​Preview​Html [HTML](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) The HTML of the customer notification for the order edit. * notification​Preview​Title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The customer notification title. * original​Order [Order!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) non-null The order without any changes applied. * shipping​Lines [\[Calculated​Shipping​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CalculatedShippingLine) non-null Returns the shipping lines on the order that existed before starting the edit. Will include any changes that have been made as well as shipping lines added during the current edit. Returns only the first 250 shipping lines. * staged​Changes [Order​Staged​Change​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderStagedChangeConnection) non-null List of changes made to the order during the current edit. * subtotal​Line​Items​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The sum of the quantities for the line items that contribute to the order's subtotal. * subtotal​Price​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The subtotal of the line items, in shop and presentment currencies, after all the discounts are applied. The subtotal doesn't include shipping. The subtotal includes taxes for taxes-included orders and excludes taxes for taxes-excluded orders. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null Taxes charged for the line item. * total​Outstanding​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null Total price of the order less the total amount received from the customer in shop and presentment currencies. * total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null Total amount of the order (includes taxes and discounts) in shop and presentment currencies. * committed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * [Cart​Transform](https://shopify.dev/docs/api/admin-graphql/latest/objects/CartTransform) OBJECT A deployed cart transformation function that actively modifies how products appear and behave in customer carts. Cart transforms enable sophisticated merchandising strategies by programmatically merging, expanding, or updating cart line items based on custom business logic. Use the `CartTransform` object to: * Monitor active bundling and cart modification logic * Track transform function deployment status and configuration * Manage error handling behavior for cart processing failures * Coordinate multiple transforms when running complex merchandising strategies * Analyze transform performance and customer interaction patterns Each cart transform links to a specific [Shopify Function](https://shopify.dev/docs/apps/build/functions) that contains the actual cart modification logic. The `blockOnFailure` setting determines whether cart processing should halt when the transform encounters errors, or whether it should allow customers to proceed with unmodified carts. This flexibility ensures merchants can balance feature richness with checkout reliability. Transform functions operate during cart updates, product additions, and checkout initiation, providing multiple touchpoints to enhance the shopping experience. They integrate seamlessly with existing cart APIs while extending functionality beyond standard product catalog capabilities. The function ID connects to your deployed function code, while the configuration settings control how the transform behaves in different scenarios. Multiple transforms can work together, processing cart modifications in sequence to support complex merchandising workflows. Learn more about [customized bundles](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle), and about the [Cart Transform Function API](https://shopify.dev/docs/api/functions/latest/cart-transform). * block​On​Failure [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether a run failure will block cart and checkout operations. * function​Id [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The ID for the Cart Transform function. * 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. * [Cash​Tracking​Adjustment](https://shopify.dev/docs/api/admin-graphql/latest/objects/CashTrackingAdjustment) OBJECT Tracks an adjustment to the cash in a cash tracking session for a point of sale device over the course of a shift. * cash [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount of cash being added or removed. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note entered when the adjustment was made. * staff​Member [Staff​Member!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) non-null The staff member who made the adjustment. * time [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The time when the adjustment was made. * [Cash​Tracking​Session](https://shopify.dev/docs/api/admin-graphql/latest/objects/CashTrackingSession) OBJECT Tracks the balance in a cash drawer for a point of sale device over the course of a shift. * adjustments [Cash​Tracking​Adjustment​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CashTrackingAdjustmentConnection) non-null The adjustments made to the cash drawer during this session. * cash​Tracking​Enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this session is tracking cash payments. * cash​Transactions [Order​Transaction​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderTransactionConnection) non-null The cash transactions made during this session. * closing​Balance [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The counted cash balance when the session was closed. * closing​Note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note entered when the session was closed. * closing​Staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The user who closed the session. * closing​Time [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) When the session was closed. * expected​Balance [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The expected balance at the end of the session or the expected current balance for sessions that are still open. * expected​Closing​Balance [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The amount that was expected to be in the cash drawer at the end of the session, calculated after the session was closed. * expected​Opening​Balance [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The amount expected to be in the cash drawer based on the previous session. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) The location of the point of sale device during this session. * net​Cash​Sales [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The net cash sales made for the duration of this cash tracking session. * opening​Balance [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The counted cash balance when the session was opened. * opening​Note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note entered when the session was opened. * opening​Staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The user who opened the session. * opening​Time [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null When the session was opened. * register​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The register name for the point of sale device that this session is tracking cash for. * total​Adjustments [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The sum of all adjustments made during the session, excluding the final adjustment. * total​Cash​Refunds [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The sum of all cash refunds for the duration of this cash tracking session. * total​Cash​Sales [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The sum of all cash sales for the duration of this cash tracking session. * total​Discrepancy [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The total discrepancy for the session including starting and ending. * [Catalog​Csv​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/CatalogCsvOperation) OBJECT A catalog csv operation represents a CSV file import. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * processed​Row​Count [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The count of processed rows, summing imported, failed, and skipped rows. * row​Count [Row​Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/RowCount) Represents a rows objects within this background operation. * status [Resource​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ResourceOperationStatus) non-null The status of this operation. * [Channel](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) OBJECT A channel represents an app where you sell a group of products and collections. A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. * app [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The underlying app used by the channel. * collection​Publications​V3 [Resource​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection) non-null The list of collection publications. Each record represents information about the publication of a collection. * collections [Collection​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CollectionConnection) non-null The list of collections published to the channel. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique identifier for the channel. * has​Collection [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the collection is available to the channel. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The collection ID to check. *** * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the channel. * product​Publications​V3 [Resource​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection) non-null The list of product publication records for products published to this channel. * products [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-null The list of products published to the channel. * products​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) Retrieves the total count of [`products`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) published to a specific sales channel. Limited to a maximum of 10000 by default. * supports​Future​Publishing [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the channel supports future publishing. * navigation​Items [\[Navigation​Item!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/NavigationItem) non-nullDeprecated * overview​Path [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Deprecated * product​Publications [Product​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductPublicationConnection) non-nullDeprecated * [Channel​Definition](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelDefinition) OBJECT A channel definition represents channels surfaces on the platform. A channel definition can be a platform or a subsegment of it such as Facebook Home, Instagram Live, Instagram Shops, or WhatsApp chat. * channel​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Name of the channel that this sub channel belongs to. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Unique string used as a public identifier for the channel definition. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID for the channel definition. * is​Marketplace [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this channel definition represents a marketplace. * sub​Channel​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live). * svg​Icon [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [Channel​Information](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelInformation) OBJECT Contains the information for a given sales channel. * app [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The app associated with the channel. * channel​Definition [Channel​Definition](https://shopify.dev/docs/api/admin-graphql/latest/objects/ChannelDefinition) The channel definition associated with the channel. * channel​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID for the channel. * display​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The publishing destination display name or channel name. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * [Checkout​Profile](https://shopify.dev/docs/api/admin-graphql/latest/objects/CheckoutProfile) OBJECT A checkout profile defines the branding settings and the UI extensions for a store's checkout. A checkout profile could be published or draft. A store might have at most one published checkout profile, which is used to render their live checkout. The store could also have multiple draft profiles that were created, previewed, and published using the admin checkout editor. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the checkout profile was created. * edited​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the checkout profile was last edited. * 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 the checkout profile is published or not. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The profile name. * typ​Osp​Pages​Active [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the checkout profile Thank You Page and Order Status Page are actively using extensibility or not. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the checkout profile was last updated. * [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 * [Comment](https://shopify.dev/docs/api/admin-graphql/latest/objects/Comment) OBJECT A comment on an article. * article [Article](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article) The article associated with the comment. * author [Comment​Author!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CommentAuthor) non-null The comment’s author. * body [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The content of the comment. * body​Html [HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) non-null The content of the comment, complete with HTML formatting. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the comment 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. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * ip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The IP address of the commenter. * is​Published [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether or not the comment is published. * published​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the comment was published. * status [Comment​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CommentStatus) non-null The status of the comment. * updated​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the comment was last updated. * user​Agent [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The user agent of the commenter. * [Comment​Event](https://shopify.dev/docs/api/admin-graphql/latest/objects/CommentEvent) OBJECT Comment events are generated by staff members of a shop. They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer. * action [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The action that occured. * app​Title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the app that created the event. * attachments [\[Comment​Event​Attachment!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CommentEventAttachment) non-null The attachments associated with the comment event. * attribute​To​App [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the event was created by an app. * attribute​To​User [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the event was caused by an admin user. * author [Staff​Member!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) non-null The name of the user that authored the comment event. * can​Delete [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the comment event can be deleted. If true, then the comment event can be deleted. * can​Edit [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the comment event can be edited. If true, then the comment event can be edited. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the event was created. * critical​Alert [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the event is critical. * edited [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the comment event has been edited. If true, then the comment event has been edited. * embed [Comment​Event​Embed](https://shopify.dev/docs/api/admin-graphql/latest/unions/CommentEventEmbed) The object reference associated with the comment event. For example, a product or discount). * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * message [Formatted​String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/FormattedString) non-null Human readable text that describes the event. * raw​Message [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The raw body of the comment event. * subject [Comment​Event​Subject](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/CommentEventSubject) The parent subject to which the comment event belongs. * [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​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyAddress) OBJECT Represents a billing or shipping address for a company location. * address1 [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The first line of the address. Typically the street address or PO Box number. * address2 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The second line of the address. Typically the number of the apartment, suite, or unit. * city [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the city, district, village, or town. * company​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the company. * country [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the country. * country​Code [Country​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) non-null The two-letter code for the country of the address. For example, US. * 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 address was created. * first​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The first name of the recipient. * formatted​Address [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The formatted version of the address. * with​Name [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false ### Arguments Whether to include the recipient's name in the formatted address. * with​Company​Name [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:true Whether to include the company name in the formatted address. *** * formatted​Area [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A comma-separated list of the values for city, province, and country. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * last​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The last name of the recipient. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique phone number for the customer. Formatted using E.164 standard. For example, *+16135551111*. * province [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The region of the address, such as the province, state, or district. * recipient [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The identity of the recipient e.g. 'Receiving Department'. * 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 address was last updated. * zip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The zip or postal code of the address. * zone​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The alphanumeric code for the region. For example, ON. * [Company​Contact](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) OBJECT A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). * company [Company!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) non-null The company to which the contact belongs. * 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 contact was created at Shopify. * customer [Customer!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) non-null The customer associated to this contact. * 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 contact. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * is​Main​Contact [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the contact is the main contact of the company. * lifetime​Duration [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The lifetime duration of the company contact, since its creation date on Shopify. Examples: `1 year`, `2 months`, `3 days`. * locale [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The company contact's locale (language). * orders [Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderConnection) non-null The list of orders for the company contact. * 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 this company contact. * title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The company contact's job title. * 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 contact was last updated. * [Company​Contact​Role](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContactRole) OBJECT The role for a [company contact](https://shopify.dev/api/admin-graphql/latest/objects/companycontact). * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of a role. For example, `admin` or `buyer`. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note for the role. * [Company​Contact​Role​Assignment](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContactRoleAssignment) OBJECT The CompanyContactRoleAssignment describes the company and location associated to a company contact's role. * company [Company!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) non-null The company this role assignment belongs to. * company​Contact [Company​Contact!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) non-null The company contact for whom this role is assigned. * company​Location [Company​Location!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) non-null The company location to which the role is assigned. * 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)) when the assignment record was created. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * role [Company​Contact​Role!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContactRole) non-null The role that's assigned to the company contact. * 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 assignment record was last updated. * [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 * [Company​Location​Catalog](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocationCatalog) OBJECT A list of products with publishing and pricing information associated with company locations. * company​Locations [Company​Location​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CompanyLocationConnection) non-null The company locations associated with the catalog. * company​Locations​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of company locations associated with the catalog. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * operations [\[Resource​Operation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/ResourceOperation) non-null Most recent catalog operations. * price​List [Price​List](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) The price list associated with the catalog. * publication [Publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) A group of products and collections that's published to a catalog. * status [Catalog​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CatalogStatus) non-null The status of the catalog. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the catalog. * [Company​Location​Staff​Member​Assignment](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocationStaffMemberAssignment) OBJECT A representation of store's staff member who is assigned to a [company location](https://shopify.dev/api/admin-graphql/latest/objects/CompanyLocation) of the shop. The staff member's actions will be limited to objects associated with the assigned company location. * company​Location [Company​Location!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) non-null The company location the staff member is assigned to. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * staff​Member [Staff​Member!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) non-null Represents the data of a staff member who's assigned to a company location. * [Consent​Policy](https://shopify.dev/docs/api/admin-graphql/latest/objects/ConsentPolicy) OBJECT A consent policy describes the level of consent that the merchant requires from the user before actually collecting and processing the data. * consent​Required [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Whether consent is required for the region. * country​Code [Privacy​Country​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/PrivacyCountryCode) The `ISO 3166` country code for which the policy applies. * data​Sale​Opt​Out​Required [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Whether data sale opt-out is required for the region. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The global ID of the consent policy. IDs prefixed with `SD-` are system default policies. * region​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The `ISO 3166` region code for which the policy applies. * shop​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The global ID of the shop that owns the policy. * [Currency​Exchange​Adjustment](https://shopify.dev/docs/api/admin-graphql/latest/objects/CurrencyExchangeAdjustment) OBJECT Represents a currency exchange adjustment applied to an order transaction. * adjustment [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The adjustment amount in both shop and presentment currencies. * final​Amount​Set [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The final amount in both shop and presentment currencies after the adjustment. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * original​Amount​Set [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The original amount in both shop and presentment currencies before the adjustment. * [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 * [Customer​Account​App​Extension​Page](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerAccountAppExtensionPage) OBJECT An app extension page for the customer account navigation menu. * app​Extension​Uuid [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The UUID of the app extension. * 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. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique, human-friendly string for the customer account page. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID for the customer account page. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the customer account page. * [Customer​Account​Native​Page](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerAccountNativePage) OBJECT A native page for the customer account navigation menu. * 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. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique, human-friendly string for the customer account page. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID for the customer account page. * page​Type [Customer​Account​Native​Page​Page​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerAccountNativePagePageType) non-null The type of customer account native page. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the customer account page. * [Customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod) OBJECT A customer's payment method. * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer to whom the payment method belongs. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of this payment method. * instrument [Customer​Payment​Instrument](https://shopify.dev/docs/api/admin-graphql/latest/unions/CustomerPaymentInstrument) The instrument for this payment method. * mandates [Payment​Mandate​Resource​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PaymentMandateResourceConnection) non-null The mandates associated with the payment method. * revoked​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The time that the payment method was revoked. * revoked​Reason [Customer​Payment​Method​Revocation​Reason](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerPaymentMethodRevocationReason) The revocation reason for this payment method. * subscription​Contracts [Subscription​Contract​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionContractConnection) non-null List Subscription Contracts. * [Customer​Segment​Members​Query](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerSegmentMembersQuery) OBJECT A job to determine a list of members, such as customers, that are associated with an individual segment. * current​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The current total number of members in a given segment. * done [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null This indicates if the job is still queued or has been run. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID that's returned when running an asynchronous mutation. * [Customer​Visit](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerVisit) OBJECT Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * landing​Page [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) URL of the first page the customer landed on for the session. * landing​Page​Html [HTML](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1. * marketing​Event [Marketing​Event](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketingEvent) Represent actions taken by an app, on behalf of a merchant, to market Shopify resources such as products, collections, and discounts. * occurred​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the customer's session occurred. * referral​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: *ref*, *source*, or *r*. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. * referral​Info​Html [Formatted​String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/FormattedString) non-null Referral information with URLs linked in HTML. * referrer​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) Webpage where the customer clicked a link that sent them to the online store. For example, ** or *android-app\://com.google.android.gm*. * source [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. * source​Description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Describes the source explicitly for first or last session. * source​Type [Marketing​Tactic](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingTactic) Type of marketing tactic. * utm​Parameters [UTMParameters](https://shopify.dev/docs/api/admin-graphql/latest/objects/UTMParameters) A set of UTM parameters gathered from the URL parameters of the referrer. * [Delivery​Carrier​Service](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCarrierService) OBJECT A carrier service (also known as a carrier calculated service or shipping service) provides real-time shipping rates to Shopify. Some common carrier services include Canada Post, FedEx, UPS, and USPS. The term **carrier** is often used interchangeably with the terms **shipping company** and **rate provider**. Using the CarrierService resource, you can add a carrier service to a shop and then provide a list of applicable shipping rates at checkout. You can even use the cart data to adjust shipping rates and offer shipping discounts based on what is in the customer's cart. ## Requirements for accessing the CarrierService resource To access the CarrierService resource, add the `write_shipping` permission to your app's requested scopes. For more information, see [API access scopes](https://shopify.dev/docs/admin-api/access-scopes). Your app's request to create a carrier service will fail unless the store installing your carrier service meets one of the following requirements: * It's on the Advanced Shopify plan or higher. * It's on the Shopify plan with yearly billing, or the carrier service feature has been added to the store for a monthly fee. For more information, contact [Shopify Support](https://help.shopify.com/questions). * It's a development store. *** Note If a store changes its Shopify plan, then the store's association with a carrier service is deactivated if the store no long meets one of the requirements above. *** ## Providing shipping rates to Shopify When adding a carrier service to a store, you need to provide a POST endpoint rooted in the `callbackUrl` property where Shopify can retrieve applicable shipping rates. The callback URL should be a public endpoint that expects these requests from Shopify. ### Example shipping rate request sent to a carrier service ```json { "rate": { "origin": { "country": "CA", "postal_code": "K2P1L4", "province": "ON", "city": "Ottawa", "name": null, "address1": "150 Elgin St.", "address2": "", "address3": null, "phone": null, "fax": null, "email": null, "address_type": null, "company_name": "Jamie D's Emporium" }, "destination": { "country": "CA", "postal_code": "K1M1M4", "province": "ON", "city": "Ottawa", "name": "Bob Norman", "address1": "24 Sussex Dr.", "address2": "", "address3": null, "phone": null, "fax": null, "email": null, "address_type": null, "company_name": null }, "items": [{ "name": "Short Sleeve T-Shirt", "sku": "", "quantity": 1, "grams": 1000, "price": 1999, "vendor": "Jamie D's Emporium", "requires_shipping": true, "taxable": true, "fulfillment_service": "manual", "properties": null, "product_id": 48447225880, "variant_id": 258644705304 }], "currency": "USD", "locale": "en" } } ``` ### Example response ```json { "rates": [ { "service_name": "canadapost-overnight", "service_code": "ON", "total_price": "1295", "description": "This is the fastest option by far", "currency": "CAD", "min_delivery_date": "2013-04-12 14:48:45 -0400", "max_delivery_date": "2013-04-12 14:48:45 -0400" }, { "service_name": "fedex-2dayground", "service_code": "2D", "total_price": "2934", "currency": "USD", "min_delivery_date": "2013-04-12 14:48:45 -0400", "max_delivery_date": "2013-04-12 14:48:45 -0400" }, { "service_name": "fedex-priorityovernight", "service_code": "1D", "total_price": "3587", "currency": "USD", "min_delivery_date": "2013-04-12 14:48:45 -0400", "max_delivery_date": "2013-04-12 14:48:45 -0400" } ] } ``` The `address3`, `fax`, `address_type`, and `company_name` fields are returned by specific [ActiveShipping](https://github.com/Shopify/active_shipping) providers. For API-created carrier services, you should use only the following shipping address fields: * `address1` * `address2` * `city` * `zip` * `province` * `country` Other values remain as `null` and are not sent to the callback URL. ### Response fields When Shopify requests shipping rates using your callback URL, the response object `rates` must be a JSON array of objects with the following fields. Required fields must be included in the response for the carrier service integration to work properly. | Field | Required | Description | | - | - | - | | `service_name` | Yes | The name of the rate, which customers see at checkout. For example: `Expedited Mail`. | | `description` | Yes | A description of the rate, which customers see at checkout. For example: `Includes tracking and insurance`. | | `service_code` | Yes | A unique code associated with the rate. For example: `expedited_mail`. | | `currency` | Yes | The currency of the shipping rate. | | `total_price` | Yes | The total price expressed in subunits. If the currency doesn't use subunits, then the value must be multiplied by 100. For example: `"total_price": 500` for 5.00 CAD, `"total_price": 100000` for 1000 JPY. | | `phone_required` | No | Whether the customer must provide a phone number at checkout. | | `min_delivery_date` | No | The earliest delivery date for the displayed rate. | | `max_delivery_date` | No | The latest delivery date for the displayed rate to still be valid. | ### Special conditions * To indicate that this carrier service cannot handle this shipping request, return an empty array and any successful (20x) HTTP code. * To force backup rates instead, return a 40x or 50x HTTP code with any content. A good choice is the regular 404 Not Found code. * Redirects (30x codes) will only be followed for the same domain as the original callback URL. Attempting to redirect to a different domain will trigger backup rates. * There is no retry mechanism. The response must be successful on the first try, within the time budget listed below. Timeouts or errors will trigger backup rates. ## Response Timeouts The read timeout for rate requests are dynamic, based on the number of requests per minute (RPM). These limits are applied to each shop-app pair. The timeout values are as follows. | RPM Range | Timeout | | - | - | | Under 1500 | 10s | | 1500 to 3000 | 5s | | Over 3000 | 3s | *** Note These values are upper limits and should not be interpretted as a goal to develop towards. Shopify is constantly evaluating the performance of the platform and working towards improving resilience as well as app capabilities. As such, these numbers may be adjusted outside of our normal versioning timelines. *** ## Server-side caching of requests Shopify provides server-side caching to reduce the number of requests it makes. Any shipping rate request that identically matches the following fields will be retrieved from Shopify's cache of the initial response: * variant IDs * default shipping box weight and dimensions * variant quantities * carrier service ID * origin address * destination address * item weights and signatures If any of these fields differ, or if the cache has expired since the original request, then new shipping rates are requested. The cache expires 15 minutes after rates are successfully returned. If an error occurs, then the cache expires after 30 seconds. * active [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the carrier service is active. * available​Services​For​Countries [\[Delivery​Available​Service!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryAvailableService) non-null The list of services offered for given destinations. * callback​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL endpoint that Shopify needs to retrieve shipping rates. * formatted​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The properly formatted name of the shipping service provider, ready to display. * icon [Image!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) non-null The logo of the service provider. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the shipping service provider. * supports​Service​Discovery [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples. * [Delivery​Condition](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCondition) OBJECT A condition that must pass for a delivery method definition to be applied to an order. * condition​Criteria [Delivery​Condition​Criteria!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DeliveryConditionCriteria) non-null The value (weight or price) that the condition field is compared to. * field [Delivery​Condition​Field!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DeliveryConditionField) non-null The field to compare the criterion value against, using the operator. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * operator [Delivery​Condition​Operator!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DeliveryConditionOperator) non-null The operator to compare the field and criterion value. * [Delivery​Country](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCountry) OBJECT A country that is used to define a shipping zone. * code [Delivery​Country​Code​Or​Rest​Of​World!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCountryCodeOrRestOfWorld) non-null A two-letter country code in ISO 3166-1 alpha-2 standard. It also includes a flag indicating whether the country should be a part of the 'Rest Of World' shipping zone. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The full name of the country. * provinces [\[Delivery​Province!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProvince) non-null The list of regions associated with this country. * translated​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The translated name of the country. The translation returned is based on the system's locale. * [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 * [Delivery​Location​Group](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryLocationGroup) OBJECT A location group is a collection of locations. They share zones and delivery methods across delivery profiles. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * locations [Location​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocationConnection) non-null A list of all locations that are part of this location group. * locations​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) A count of all locations that are part of this location group. * [Delivery​Method](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryMethod) OBJECT The delivery method used by a fulfillment order. * additional​Information [Delivery​Method​Additional​Information](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryMethodAdditionalInformation) The Additional information to consider when performing the delivery. * branded​Promise [Delivery​Branded​Promise](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryBrandedPromise) The branded promise that was presented to the buyer during checkout. For example: Shop Promise. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * max​Delivery​Date​Time [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. * method​Type [Delivery​Method​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DeliveryMethodType) non-null The type of the delivery method. * min​Delivery​Date​Time [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. * presented​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the delivery option that was presented to the buyer during checkout. * service​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A reference to the shipping method. * source​Reference [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Source reference is promise provider specific data associated with delivery promise. * [Delivery​Method​Definition](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryMethodDefinition) OBJECT A method definition contains the delivery rate and the conditions that must be met for the method to be applied. * active [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this method definition is active. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The description of the method definition. Only available on shipping rates that are custom. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * method​Conditions [\[Delivery​Condition!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCondition) non-null The method conditions that must pass for this method definition to be applied to an order. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the method definition. * rate​Provider [Delivery​Rate​Provider!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DeliveryRateProvider) non-null The provided rate for this method definition, from a rate definition or participant. * [Delivery​Participant](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryParticipant) OBJECT A participant defines carrier-calculated rates for shipping services with a possible merchant-defined fixed fee or a percentage-of-rate fee. * adapt​To​New​Services​Flag [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether to display new shipping services automatically to the customer when the service becomes available. * carrier​Service [Delivery​Carrier​Service!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCarrierService) non-null The carrier used for this participant. * fixed​Fee [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The merchant-defined fixed fee for this participant. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * participant​Services [\[Delivery​Participant​Service!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryParticipantService) non-null The carrier-specific services offered by the participant, and whether each service is active. * percentage​Of​Rate​Fee [Float!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) non-null The merchant-defined percentage-of-rate fee for this participant. * [Delivery​Profile](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfile) OBJECT A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. Learn more about [building with delivery profiles](https://shopify.dev/apps/build/purchase-options/deferred/delivery-and-deferment/build-delivery-profiles). * active​Method​Definitions​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of active shipping rates for the profile. * default [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this is the default profile. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * legacy​Mode [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this shop has enabled legacy compatibility mode for delivery profiles. * locations​Without​Rates​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of locations without rates defined. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the delivery profile. * origin​Location​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of active origin locations for the profile. * product​Variants​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) How many product variants are in this profile. * profile​Items [Delivery​Profile​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DeliveryProfileItemConnection) non-null The products and variants associated with this profile. * profile​Location​Groups [\[Delivery​Profile​Location​Group!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfileLocationGroup) non-null The location groups and associated zones using this profile. * selling​Plan​Groups [Selling​Plan​Group​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SellingPlanGroupConnection) non-null Selling plan groups associated with the specified delivery profile. * unassigned​Locations [\[Location!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) non-null List of locations that haven't been assigned to a location group for this profile. * unassigned​Locations​Paginated [Location​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/LocationConnection) non-null List of locations that have not been assigned to a location group for this profile. * version [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The version of the delivery profile. * zone​Country​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of countries with active rates to deliver to. * product​Variants​Count​V2 [Delivery​Product​Variants​Count!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProductVariantsCount) non-nullDeprecated * [Delivery​Profile​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfileItem) OBJECT A product and the subset of associated variants that are part of this delivery profile. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * product [Product!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) non-null A product associated with this profile. * variants [Product​Variant​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductVariantConnection) non-null The product variants associated with this delivery profile. * [Delivery​Promise​Participant](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryPromiseParticipant) OBJECT Returns enabled delivery promise participants. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of the promise participant. * owner [Delivery​Promise​Participant​Owner](https://shopify.dev/docs/api/admin-graphql/latest/unions/DeliveryPromiseParticipantOwner) The resource that the participant is attached to. * owner​Type [Delivery​Promise​Participant​Owner​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DeliveryPromiseParticipantOwnerType) non-null The owner type of the participant. * [Delivery​Promise​Provider](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryPromiseProvider) OBJECT A delivery promise provider. Currently restricted to select approved delivery promise partners. * active [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the delivery promise provider is active. Defaults to `true` when creating a provider. * fulfillment​Delay [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The number of seconds to add to the current time as a buffer when looking up delivery promises. Represents how long the shop requires before releasing an order to the fulfillment provider. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * location [Location!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) non-null The location associated with this delivery promise provider. * time​Zone [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The time zone to be used for interpreting day of week and cutoff times in delivery schedules when looking up delivery promises. * [Delivery​Province](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProvince) OBJECT A region that is used to define a shipping zone. * code [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The code of the region. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The full name of the region. * translated​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The translated name of the region. The translation returned is based on the system's locale. * [Delivery​Rate​Definition](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryRateDefinition) OBJECT The merchant-defined rate of the [DeliveryMethodDefinition](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryMethodDefinition). * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * price [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The price of this rate. * [Delivery​Zone](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryZone) OBJECT A zone is a group of countries that have the same shipping rates. Customers can order products from a store only if they choose a shipping destination that's included in one of the store's zones. * countries [\[Delivery​Country!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryCountry) non-null The list of countries within the zone. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the zone. * [Discount​Automatic​Bxgy](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBxgy) OBJECT The `DiscountAutomaticBxgy` object lets you manage [buy X get Y discounts (BXGY)](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) that are automatically applied on a cart and at checkout. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items. The `DiscountAutomaticBxgy` object stores information about automatic BXGY discounts that apply to specific [products and variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountProducts), [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCollections), or [all items in a cart](https://shopify.dev/docs/api/admin-graphql/latest/objects/AllDiscountItems). Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts), including limitations and considerations. *** Note The [`DiscountCodeBxgy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeBxgy) object has similar functionality to the `DiscountAutomaticBxgy` object, but customers need to enter a code to receive a discount. API versions prior to `2025-10` only return automatic discounts with `context` set to `all`, discounts with other values are filtered out. *** * async​Usage​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed. * combines​With [Discount​Combines​With!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCombinesWith) non-null The [discount classes](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types). * context [Discount​Context!](https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountContext) non-null The context defining which buyers can use the discount. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the discount was created. * customer​Buys [Discount​Customer​Buys!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCustomerBuys) non-null The items eligible for the discount and the required quantity of each to receive the discount. * customer​Gets [Discount​Customer​Gets!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCustomerGets) non-null The items in the order that qualify for the discount, their quantities, and the total value of the discount. * discount​Classes [\[Discount​Class!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass) non-null The classes of the discount. * ends​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify `null`. * 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. * starts​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the discount becomes active and is available to customers. * status [Discount​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountStatus) non-null The status of the discount that describes its availability, expiration, or pending activation. * summary [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The discount's name that displays to merchants in the Shopify admin and to customers. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the discount was updated. * uses​Per​Order​Limit [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The maximum number of times that the discount can be applied to an order. * discount​Class [Merchandise​Discount​Class!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MerchandiseDiscountClass) non-nullDeprecated * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-nullDeprecated * usage​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) 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 * [Discount​Redeem​Code​Bulk​Creation](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountRedeemCodeBulkCreation) OBJECT The properties and status of a bulk discount redeem code creation operation. * codes [Discount​Redeem​Code​Bulk​Creation​Code​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/DiscountRedeemCodeBulkCreationCodeConnection) non-null The result of each code creation operation associated with the bulk creation operation including any errors that might have occurred during the operation. * codes​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of codes to create. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the bulk creation was created. * discount​Code [Discount​Code​Node](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeNode) The code discount associated with the created codes. * done [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the bulk creation is still queued (`false`) or has been run (`true`). * failed​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of codes that weren't created successfully. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * imported​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of codes created successfully. * [Domain](https://shopify.dev/docs/api/admin-graphql/latest/objects/Domain) OBJECT A unique string that represents the address of a Shopify store on the Internet. * host [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The host name of the domain. For example, `example.com`. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * localization [Domain​Localization](https://shopify.dev/docs/api/admin-graphql/latest/objects/DomainLocalization) The localization of the domain, if the domain doesn't redirect. * market​Web​Presence [Market​Web​Presence](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketWebPresence) The web presence of the domain. * ssl​Enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether SSL is enabled. * url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL of the domain (for example, `https://example.com`). * [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 * [Draft​Order​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem) OBJECT The line item for a draft order. * applied​Discount [Draft​Order​Applied​Discount](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderAppliedDiscount) The custom applied discount. * approximate​Discounted​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The `discountedTotal` divided by `quantity`, equal to the average value of the line item price per unit after discounts are applied. This value doesn't include discounts applied to the entire draft order. * components [\[Draft​Order​Line​Item!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem) non-null The components of the draft order line item. * custom [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the line item is custom (`true`) or contains a product variant (`false`). * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of attributes that represent custom features or special requests. * custom​Attributes​V2 [\[Typed​Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TypedAttribute) non-null The list of additional information (metafields) with the associated types. * discounted​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price with discounts applied. * fulfillment​Service [Fulfillment​Service](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) Name of the service provider who fulfilled the order. Valid values are either **manual** or the name of the provider. For example, **amazon**, **shipwire**. Deleted fulfillment services will return null. * 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 of the product variant. * is​Gift​Card [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the line item represents the purchase of a gift card. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the product. * original​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price excluding discounts, equal to the original unit price multiplied by quantity. * original​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The price without any discounts applied. * original​Unit​Price​With​Currency [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The original custom line item input price. * price​Override [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The price override for the line item. * product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) The product for the line item. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of items. For a bundle item, this is the quantity of bundles, not the quantity of items contained in the bundles themselves. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether physical shipping is required for the variant. * sku [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The SKU number of the product variant. * taxable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the variant is taxable. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of tax lines. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the product or variant. This field only applies to custom line items. * total​Discount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total discount amount. * uuid [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The UUID of the draft order line item. Must be unique and consistent across requests. This field is mandatory in order to manipulate drafts with bundles. * variant [Product​Variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) The product variant for the line item. * variant​Title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the variant. * vendor [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the vendor who created the product variant. * weight [Weight](https://shopify.dev/docs/api/admin-graphql/latest/objects/Weight) The weight unit and value. * bundle​Components [\[Draft​Order​Line​Item!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem) non-nullDeprecated * discounted​Total [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * discounted​Unit​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * discounted​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-nullDeprecated * grams [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) Deprecated * original​Total [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * original​Unit​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Discount [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * [Draft​Order​Tag](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderTag) OBJECT Represents a draft order tag. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Handle of draft order tag. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null ID of draft order tag. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Title of draft order tag. * [Duty](https://shopify.dev/docs/api/admin-graphql/latest/objects/Duty) OBJECT The duty details for a line item. * country​Code​Of​Origin [Country​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty. * harmonized​System​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The harmonized system code of the item used in calculating the duty. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * price [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The amount of the duty. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of taxes charged on the duty. * [Exchange​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/ExchangeLineItem) OBJECT An item for exchange. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Items [\[Line​Item!\]](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) The order line items for the exchange. * processable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the exchange item that can be processed. * processed​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the exchange item that have been processed. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of units ordered, including refunded and removed units. * unprocessed​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the exchange item that haven't been processed. * variant​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) The ID of the variant at time of return creation. * line​Item [Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) Deprecated * [External​Video](https://shopify.dev/docs/api/admin-graphql/latest/objects/ExternalVideo) OBJECT Represents a video hosted outside of Shopify. * alt [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A word or phrase to describe the contents or the function of a file. * 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)) when the file was created. * embed​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The embed URL of the video for the respective host. * file​Errors [\[File​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FileError) non-null Any errors that have occurred on the file. * file​Status [File​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FileStatus) non-null The status of the file. * host [Media​Host!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaHost) non-null The host of the external video. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaContentType) non-null The media content type. * media​Errors [\[Media​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaError) non-null Any errors which have occurred on the media. * media​Warnings [\[Media​Warning!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaWarning) non-null The warnings attached to the media. * origin​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The origin URL of the video on the respective host. * preview [Media​Preview​Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaPreviewImage) The preview image for the media. * status [Media​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaStatus) non-null Current status of the media. * 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 file was last updated. * embedded​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-nullDeprecated * [Fulfillment](https://shopify.dev/docs/api/admin-graphql/latest/objects/Fulfillment) OBJECT Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the fulfillment was created. * delivered​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date that this fulfillment was delivered. * display​Status [Fulfillment​Display​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentDisplayStatus) Human readable display status for this fulfillment. * estimated​Delivery​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The estimated date that this fulfillment will arrive. * events [Fulfillment​Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentEventConnection) non-null The history of events associated with this fulfillment. * fulfillment​Line​Items [Fulfillment​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentLineItemConnection) non-null List of the fulfillment's line items. * fulfillment​Orders [Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/FulfillmentOrderConnection) non-null A paginated list of fulfillment orders for the fulfillment. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * in​Transit​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the fulfillment went into transit. * 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. * location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) The location that the fulfillment was processed at. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Human readable reference identifier for this fulfillment. * order [Order!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) non-null The order for which the fulfillment was created. * origin​Address [Fulfillment​Origin​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOriginAddress) The address at which the fulfillment occurred. This field is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the `assignedLocation` field on the [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) object instead. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether any of the line items in the fulfillment require shipping. * service [Fulfillment​Service](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) Fulfillment service associated with the fulfillment. * status [Fulfillment​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentStatus) non-null The status of the fulfillment. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null Sum of all line item quantities for the fulfillment. * tracking​Info [\[Fulfillment​Tracking​Info!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentTrackingInfo) non-null Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the fulfillment was last modified. * [Fulfillment​Constraint​Rule](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentConstraintRule) OBJECT A fulfillment constraint rule. * delivery​Method​Types [\[Delivery​Method​Type!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DeliveryMethodType) non-null Delivery method types that the function is associated with. * function [Shopify​Function!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyFunction) non-null The ID for the fulfillment constraint function. * 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. * [Fulfillment​Event](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentEvent) OBJECT The fulfillment event that describes the fulfilllment status at a particular time. * address1 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The street address where this fulfillment event occurred. * city [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The city where this fulfillment event occurred. * country [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The country where this fulfillment event occurred. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the fulfillment event was created. * estimated​Delivery​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The estimated delivery date and time of the fulfillment. * happened​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The time at which this fulfillment event happened. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * latitude [Float](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) The latitude where this fulfillment event occurred. * longitude [Float](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) The longitude where this fulfillment event occurred. * message [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A message associated with this fulfillment event. * province [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The province where this fulfillment event occurred. * status [Fulfillment​Event​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentEventStatus) non-null The status of this fulfillment event. * zip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The zip code of the location where this fulfillment event occurred. * [Fulfillment​Hold](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentHold) OBJECT A fulfillment hold currently applied on a fulfillment order. * display​Reason [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The localized reason for the fulfillment hold for display purposes. * handle [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) An identifier an app can use to reference one of many holds it applied to a fulfillment order. This field must be unique among the holds that a single app applies to a single fulfillment order. * held​By​App [App](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) The app that created the fulfillment hold. * held​By​Requesting​App [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null A boolean value that indicates whether the requesting app created the fulfillment hold. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * reason [Fulfillment​Hold​Reason!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentHoldReason) non-null The reason for the fulfillment hold. * reason​Notes [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Additional information about the fulfillment hold reason. * [Fulfillment​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentLineItem) OBJECT Represents a line item from an order that's included in a fulfillment. * discounted​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price after discounts are applied in shop and presentment currencies. This value doesn't include order-level discounts. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Item [Line​Item!](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) non-null The associated order's line item. * original​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total price before discounts are applied in shop and presentment currencies. * quantity [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) Number of line items in the fulfillment. * discounted​Total [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * original​Total [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. * [Fulfillment​Order​Destination](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderDestination) OBJECT Represents the destination where the items should be sent upon fulfillment. * address1 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The first line of the address of the destination. * address2 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The second line of the address of the destination. * city [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The city of the destination. * company [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The company of the destination. * country​Code [Country​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The two-letter country code of the destination. * email [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The email of the customer at the destination. * first​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The first name of the customer at the destination. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * last​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The last name of the customer at the destination. * location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) The location designated for the pick-up of the fulfillment order. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The phone number of the customer at the destination. * province [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The province of the destination. * zip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The ZIP code of the destination. * [Fulfillment​Order​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderLineItem) OBJECT Associates an order line item with quantities requiring fulfillment from the respective fulfillment order. * financial​Summaries [\[Fulfillment​Order​Line​Item​Financial​Summary!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderLineItemFinancialSummary) non-null The financial summary for the Fulfillment Order's Line Items. * 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 to the line item's variant. * inventory​Item​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) The ID of the inventory item. * line​Item [Line​Item!](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) non-null The associated order line item. * product​Title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the product. * remaining​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of units remaining to be fulfilled. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether physical shipping is required for the variant. * sku [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The variant SKU number. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total number of units to be fulfilled. * variant [Product​Variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) The product variant associated to the fulfillment order line item. * variant​Title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the variant. * vendor [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the vendor who made the variant. * warnings [\[Fulfillment​Order​Line​Item​Warning!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderLineItemWarning) non-null Warning messages for a fulfillment order line item. * weight [Weight](https://shopify.dev/docs/api/admin-graphql/latest/objects/Weight) The weight of a line item unit. * original​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-nullDeprecated * [Fulfillment​Order​Merchant​Request](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) OBJECT A request made by the merchant or an order management app to a fulfillment service for a fulfillment order. * fulfillment​Order [Fulfillment​Order!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) non-null The fulfillment order associated with the merchant request. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * kind [Fulfillment​Order​Merchant​Request​Kind!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderMerchantRequestKind) non-null The kind of request made. * message [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The optional message that the merchant included in the request. * request​Options [JSON](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) Additional options requested by the merchant. These depend on the `kind` of the request. For example, for a `FULFILLMENT_REQUEST`, one option is `notify_customer`, which indicates whether the merchant intends to notify the customer upon fulfillment. The fulfillment service can then set `notifyCustomer` when making calls to `FulfillmentCreate`. * response​Data [JSON](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) The response from the fulfillment service. * sent​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The timestamp when the request was made. * [Generic​File](https://shopify.dev/docs/api/admin-graphql/latest/objects/GenericFile) OBJECT Represents any file other than HTML. * alt [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A word or phrase to describe the contents or the function of a file. * 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)) when the file was created. * file​Errors [\[File​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FileError) non-null Any errors that have occurred on the file. * file​Status [File​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FileStatus) non-null The status of the file. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * mime​Type [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The generic file's MIME type. * original​File​Size [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The generic file's size in bytes. * preview [Media​Preview​Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaPreviewImage) The preview image for the media. * 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 file was last updated. * url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The generic file's URL. * [Gift​Card](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCard) OBJECT Represents an issued gift card. * balance [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The gift card's remaining balance. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time at which the gift card was created. * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer who will receive the gift card. * deactivated​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time at which the gift card was deactivated. * enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the gift card is enabled. * expires​On [Date](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Date) The date at which the gift card will expire. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * initial​Value [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The initial value of the gift card. * last​Characters [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The final four characters of the gift card code. * masked​Code [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The gift card code. Everything but the final four characters is masked. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note associated with the gift card, which isn't visible to the customer. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The order associated with the gift card. This value is `null` if the gift card was issued manually. * recipient​Attributes [Gift​Card​Recipient](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCardRecipient) The recipient who will receive the gift card. * template​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The theme template used to render the gift card online. * transactions [Gift​Card​Transaction​Connection](https://shopify.dev/docs/api/admin-graphql/latest/connections/GiftCardTransactionConnection) The transaction history of the gift card. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time at which the gift card was updated. * [Gift​Card​Credit​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCardCreditTransaction) OBJECT A credit transaction which increases the gift card balance. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount of the transaction. * gift​Card [Gift​Card!](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCard) non-null The gift card that the transaction belongs to. * 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. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note about the transaction. * processed​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the transaction was processed. * [Gift​Card​Debit​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCardDebitTransaction) OBJECT A debit transaction which decreases the gift card balance. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount of the transaction. * gift​Card [Gift​Card!](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCard) non-null The gift card that the transaction belongs to. * 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. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note about the transaction. * processed​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the transaction was processed. * [Inventory​Adjustment​Group](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryAdjustmentGroup) OBJECT Represents a group of adjustments made as part of the same operation. * app [App](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) The app that triggered the inventory event, if one exists. * changes [\[Inventory​Change!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryChange) non-null The set of inventory quantity changes that occurred in the inventory event. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time the inventory adjustment group was created. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * reason [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The reason for the group of adjustments. * reference​Document​Uri [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A freeform URI that represents why the inventory change happened. This can be the entity adjusting inventory quantities or the Shopify resource that's associated with the inventory adjustment. For example, a unit in a draft order might have been previously reserved, and a merchant later creates an order from the draft order. In this case, the `referenceDocumentUri` for the inventory adjustment is a URI referencing the order ID. * staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The staff member associated with the inventory event. * [Inventory​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) OBJECT Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked. Learn [more about the relationships between inventory objects](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships). * country​Code​Of​Origin [Country​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The ISO 3166-1 alpha-2 country code of where the item originated from. * country​Harmonized​System​Codes [Country​Harmonized​System​Code​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CountryHarmonizedSystemCodeConnection) non-null A list of country specific harmonized system codes. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the inventory item was created. * duplicate​Sku​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of inventory items that share the same SKU with this item. * harmonized​System​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The harmonized system code of the item. This must be a number between 6 and 13 digits. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * inventory​History​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL that points to the inventory history for the item. * inventory​Level [Inventory​Level](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) The inventory item's quantities at the specified location. * inventory​Levels [Inventory​Level​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/InventoryLevelConnection) non-null A list of the inventory item's quantities for each location that the inventory item can be stocked at. * 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. * locations​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of locations where this inventory item is stocked. * measurement [Inventory​Item​Measurement!](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItemMeasurement) non-null The packaging dimensions of the inventory item. * province​Code​Of​Origin [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The ISO 3166-2 alpha-2 province code of where the item originated from. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the inventory item requires shipping. * sku [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Inventory item SKU. Case-sensitive string. * tracked [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether inventory levels are tracked for the item. * tracked​Editable [Editable​Property!](https://shopify.dev/docs/api/admin-graphql/latest/objects/EditableProperty) non-null Whether the value of the `tracked` field for the inventory item can be changed. * unit​Cost [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) Unit cost associated with the inventory item. Note: the user must have "View product costs" permission granted in order to access this field once product granular permissions are enabled. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the inventory item was updated. * variant [Product​Variant!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) non-null The variant that owns this inventory item. * [Inventory​Item​Measurement](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItemMeasurement) OBJECT Represents the packaged dimension for an inventory item. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * weight [Weight](https://shopify.dev/docs/api/admin-graphql/latest/objects/Weight) The weight of the inventory item. * [Inventory​Level](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) OBJECT The quantities of an inventory item that are related to a specific location. Learn [more about the relationships between inventory objects](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships). * can​Deactivate [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the inventory items associated with the inventory level can be deactivated. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the inventory level was created. * deactivation​Alert [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * item [Inventory​Item!](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) non-null Inventory item associated with the inventory level. * location [Location!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) non-null The location associated with the inventory level. * quantities [\[Inventory​Quantity!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryQuantity) non-null The quantity of an inventory item at a specific location, for a quantity [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states). * scheduled​Changes [Inventory​Scheduled​Change​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/InventoryScheduledChangeConnection) non-null Scheduled changes for the requested quantity names. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the inventory level was updated. * [Inventory​Quantity](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryQuantity) OBJECT The `InventoryQuantity` object lets you manage and track inventory quantities for specific [states](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states). Inventory quantities represent different states of items such as available for purchase, committed to orders, reserved for drafts, incoming from suppliers, or set aside for quality control or safety stock. You can use [inventory levels](https://shopify.dev/docs/api/admin-graphql/latest/objects/inventorylevel) to manage where inventory items are stocked. You can also [make inventory adjustments](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryAdjustQuantities) to apply changes to inventory quantities. Inventory quantities can be managed by a merchant or by [fulfillment services](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentservice) that handle inventory tracking. Learn more about working with [Shopify's inventory management system](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps). * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The inventory state [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states) that identifies the inventory quantity. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of an inventory item at a specific location, for a quantity [name](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps#inventory-states). * updated​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) When the inventory quantity was last updated. * [Inventory​Shipment](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryShipment) OBJECT Represents an inventory shipment. * date​Created [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date the shipment was created in UTC. * date​Received [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date the shipment was initially received in UTC. * date​Shipped [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date the shipment was shipped in UTC. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Items [Inventory​Shipment​Line​Item​Connection](https://shopify.dev/docs/api/admin-graphql/latest/connections/InventoryShipmentLineItemConnection) The line items included in this shipment. * line​Items​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of line items associated with the inventory shipment. Limited to a maximum of 10000 by default. * line​Item​Total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of all items in the shipment. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the inventory shipment. * status [Inventory​Shipment​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/InventoryShipmentStatus) non-null The current status of the shipment. * total​Accepted​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of items accepted across all line items in this shipment. * total​Received​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of items received (both accepted and rejected) across all line items in this shipment. * total​Rejected​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of items rejected across all line items in this shipment. * tracking [Inventory​Shipment​Tracking](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryShipmentTracking) The tracking information for the shipment. * [Inventory​Shipment​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryShipmentLineItem) OBJECT Represents a single line item within an inventory shipment. * accepted​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of items that were accepted in this shipment line item. * 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) The inventory item associated with this line item. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of items in this shipment line item. * rejected​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of items that were rejected in this shipment line item. * unreceived​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of units that haven't been received (neither accepted or rejected) in this shipment line item. * [Inventory​Transfer](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransfer) OBJECT Represents the intention to move inventory between locations. * date​Created [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time the inventory transfer was created in UTC format. * destination [Location​Snapshot](https://shopify.dev/docs/api/admin-graphql/latest/objects/LocationSnapshot) Snapshot of the destination location (name, address, when snapped) with an optional link to the live Location object. If the original location is deleted, the snapshot data will still be available but the location link will be nil. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The list of events associated with the inventory transfer. * 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 inventory transfer. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Items [Inventory​Transfer​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/InventoryTransferLineItemConnection) non-null The line items associated with the inventory transfer. * line​Items​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of line items associated with the inventory transfer. Limited to a maximum of 10000 by default. * 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 inventory transfer. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Additional note attached to the inventory transfer. * origin [Location​Snapshot](https://shopify.dev/docs/api/admin-graphql/latest/objects/LocationSnapshot) Snapshot of the origin location (name, address, when snapped) with an optional link to the live Location object. If the original location is deleted, the snapshot data will still be available but the location link will be nil. * received​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of items received in the transfer. * reference​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The reference name of the inventory transfer. * shipments [Inventory​Shipment​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/InventoryShipmentConnection) non-null The shipments associated with the inventory transfer. * status [Inventory​Transfer​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/InventoryTransferStatus) non-null The current status of the transfer. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A list of tags that have been added to the inventory transfer. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of items being transferred. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Inventory​Transfer​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransferLineItem) OBJECT Represents a line item belonging to an inventory transfer. * 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) The inventory item associated with this line item. * picked​For​Shipment​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the item that has been picked for a draft shipment but not yet shipped. * processable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the item that can be actioned upon, such as editing the item quantity on the transfer or adding to a shipment. * shippable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the item that can be shipped. * shipped​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity of the item that has been shipped. * title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The title of the product associated with this line item. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total quantity of items being transferred. * [Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) OBJECT The `LineItem` object represents a single product or service that a customer purchased in an [order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). Each line item is associated with a [product variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) and can have multiple [discount allocations](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAllocation). Line items contain details about what was purchased, including the product variant, quantity, pricing, and fulfillment status. Use the `LineItem` object to manage the following processes: * [Track the quantity of items](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/build-fulfillment-solutions) ordered, fulfilled, and unfulfilled. * [Calculate prices](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders), including discounts and taxes. * Manage fulfillment through [fulfillment services](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps). * Manage [returns](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management) and [exchanges](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-exchanges). * Handle [subscriptions](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) and recurring orders. Line items can also include custom attributes and properties, allowing merchants to add specific details about each item in an order. Learn more about [managing orders and fulfillment](https://shopify.dev/docs/apps/build/orders-fulfillment). * contract [Subscription​Contract](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract) The subscription contract associated with this line item. * current​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of units ordered, excluding refunded and removed units. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of attributes that represent custom features or special requests. * discount​Allocations [\[Discount​Allocation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAllocation) non-null The discounts that have been allocated to the line item by discount applications, including discounts allocated to refunded and removed quantities. * discounted​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total discounted price of the line item in shop and presentment currencies, including refunded and removed quantities. This value doesn't include order-level discounts. Code-based discounts aren't included by default. * discounted​Unit​Price​After​All​Discounts​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The approximate unit price of the line item in shop and presentment currencies. This value includes discounts applied to refunded and removed quantities. * discounted​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The approximate unit price of the line item in shop and presentment currencies. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level or code-based discounts. * duties [\[Duty!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Duty) non-null The duties associated with the line item. * 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 to the line item's variant. * is​Gift​Card [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the line item represents the purchase of a gift card. * line​Item​Group [Line​Item​Group](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItemGroup) The line item group associated to the line item. * merchant​Editable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the line item can be edited or not. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the product, optionally appended with the title of the variant (if applicable). * non​Fulfillable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object for more fulfillment details. * original​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null In shop and presentment currencies, the total price of the line item when the order was created. This value doesn't include discounts. * original​Unit​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null In shop and presentment currencies, the unit price of the line item when the order was created. This value doesn't include discounts. * product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) The Product object associated with this line item's variant. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of units ordered, including refunded and removed units. * refundable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of units ordered, excluding refunded units and removed units. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether physical shipping is required for the variant. * restockable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the line item can be restocked. * selling​Plan [Line​Item​Selling​Plan](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItemSellingPlan) The selling plan details associated with the line item. * sku [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The variant SKU number. * staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) Staff attributed to the line item. * taxable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the variant is taxable. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null The taxes charged for the line item, including taxes charged for refunded and removed quantities. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the product at time of order creation. * total​Discount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total discount allocated to the line item in shop and presentment currencies, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts. * unfulfilled​Discounted​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null In shop and presentment currencies, the total discounted price of the unfulfilled quantity for the line item. * unfulfilled​Original​Total​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null In shop and presentment currencies, the total price of the unfulfilled quantity for the line item. This value doesn't include discounts. * unfulfilled​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of units not yet fulfilled. * variant [Product​Variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) The Variant object associated with this line item. * variant​Title [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The title of the variant at time of order creation. * vendor [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the vendor who made the variant. * can​Restock [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-nullDeprecated * discounted​Total [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * discounted​Unit​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * fulfillable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * fulfillment​Service [Fulfillment​Service](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) Deprecated * fulfillment​Status [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-nullDeprecated * original​Total [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * original​Unit​Price [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * total​Discount [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * unfulfilled​Discounted​Total [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * unfulfilled​Original​Total [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * [Line​Item​Group](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItemGroup) OBJECT A line item group (bundle) to which a line item belongs to. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of attributes that represent custom features or special requests. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * product​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) ID of the product of the line item group. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null Quantity of the line item group on the order. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Title of the line item group. * variant​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) ID of the variant of the line item group. * variant​Sku [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) SKU of the variant of the line item group. * [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 * [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) OBJECT Represents a customer mailing address. For example, a customer's default address and an order's billing address are both mailling addresses. * address1 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The first line of the address. Typically the street address or PO Box number. * address2 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The second line of the address. Typically the number of the apartment, suite, or unit. * city [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the city, district, village, or town. * company [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the customer's company or organization. * coordinates​Validated [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the address corresponds to recognized latitude and longitude values. * country [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the country. * country​Code​V2 [Country​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The two-letter code for the country of the address. For example, US. * first​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The first name of the customer. * formatted [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A formatted version of the address, customized by the provided arguments. * with​Name [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false ### Arguments Whether to include the customer's name in the formatted address. * with​Company [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:true Whether to include the customer's company in the formatted address. *** * formatted​Area [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A comma-separated list of the values for city, province, and country. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * last​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The last name of the customer. * latitude [Float](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) The latitude coordinate of the customer address. * longitude [Float](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) The longitude coordinate of the customer address. * name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The full name of the customer, based on firstName and lastName. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique phone number for the customer. * province [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The region of the address, such as the province, state, or district. * province​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The alphanumeric code for the region. For example, ON. * time​Zone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The time zone of the address. * validation​Result​Summary [Mailing​Address​Validation​Result](https://shopify.dev/docs/api/admin-graphql/latest/enums/MailingAddressValidationResult) The validation status that is leveraged by the address validation feature in the Shopify Admin. See ["Validating addresses in your Shopify admin"](https://help.shopify.com/manual/fulfillment/managing-orders/validating-order-address) for more details. * zip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The zip or postal code of the address. * country​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [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 * [Market​Catalog](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketCatalog) OBJECT A list of products with publishing and pricing information associated with markets. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * markets [Market​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MarketConnection) non-null The markets associated with the catalog. * markets​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of markets associated with the catalog. * operations [\[Resource​Operation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/ResourceOperation) non-null Most recent catalog operations. * price​List [Price​List](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) The price list associated with the catalog. * publication [Publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) A group of products and collections that's published to a catalog. * status [Catalog​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CatalogStatus) non-null The status of the catalog. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the catalog. * [Marketing​Activity](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketingActivity) OBJECT The marketing activity resource represents marketing that a merchant created through an app. * activity​List​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL of the marketing activity listing page in the marketing section. * ad​Spend [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The amount spent on the marketing activity. * app [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The app which created this marketing activity. * app​Errors [Marketing​Activity​Extension​App​Errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketingActivityExtensionAppErrors) The errors generated when an app publishes the marketing activity. * budget [Marketing​Budget](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketingBudget) The allocated budget for the marketing activity. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the marketing activity was created. * form​Data [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The completed content in the marketing activity creation form. * hierarchy​Level [Marketing​Activity​Hierarchy​Level](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingActivityHierarchyLevel) The hierarchy level of the marketing activity. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * in​Main​Workflow​Version [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the marketing activity is in the main workflow version of the marketing automation. * is​External [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null The marketing activity represents an external marketing activity. * marketing​Channel​Type [Marketing​Channel!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingChannel) non-null The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation. * marketing​Event [Marketing​Event](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketingEvent) Associated marketing event of this marketing activity. * parent​Activity​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) ID of the parent activity of this marketing activity. * parent​Remote​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ID of the parent activity of this marketing activity. * source​And​Medium [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A contextual description of the marketing activity based on the platform and tactic used. * status [Marketing​Activity​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingActivityStatus) non-null The current state of the marketing activity. * status​Badge​Type​V2 [Badge​Type](https://shopify.dev/docs/api/admin-graphql/latest/enums/BadgeType) The severity of the marketing activity's status. * status​Label [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The rendered status of the marketing activity. * status​Transitioned​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The [date and time](https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601) when the activity's status last changed. * tactic [Marketing​Tactic!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingTactic) non-null The method of marketing used for this marketing activity. * target​Status [Marketing​Activity​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingActivityStatus) The status to which the marketing activity is currently transitioning. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The marketing activity's title, which is rendered on the marketing listing page. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the marketing activity was updated. * url​Parameter​Value [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The value portion of the URL query parameter used in attributing sessions to this activity. * utm​Parameters [UTMParameters](https://shopify.dev/docs/api/admin-graphql/latest/objects/UTMParameters) The set of [Urchin Tracking Module](https://help.shopify.com/https://en.wikipedia.org/wiki/UTM_parameters) used in the URL for tracking this marketing activity. * marketing​Channel [Marketing​Channel!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingChannel) non-nullDeprecated * status​Badge​Type [Marketing​Activity​Status​Badge​Type](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingActivityStatusBadgeType) Deprecated * [Marketing​Event](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketingEvent) OBJECT Represents actions that market a merchant's store or products. * app [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The app that the marketing event is attributed to. * channel​Handle [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A human-readable description of the marketing event. * ended​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the marketing event ended. * 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. * manage​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL where the marketing event can be managed. * marketing​Channel​Type [Marketing​Channel](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingChannel) The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation. * preview​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL where the marketing event can be previewed. * remote​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) An optional ID that helps Shopify validate engagement data. * scheduled​To​End​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the marketing event is scheduled to end. * source​And​Medium [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Where the `MarketingEvent` occurred and what kind of content was used. Because `utmSource` and `utmMedium` are often used interchangeably, this is based on a combination of `marketingChannel`, `referringDomain`, and `type` to provide a consistent representation for any given piece of marketing regardless of the app that created it. * started​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the marketing event started. * type [Marketing​Tactic!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingTactic) non-null The marketing event type. * utm​Campaign [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the marketing campaign. * utm​Medium [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The medium that the marketing campaign is using. Example values: `cpc`, `banner`. * utm​Source [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The referrer of the marketing event. Example values: `google`, `newsletter`. * channel [Marketing​Channel](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketingChannel) Deprecated * target​Type​Display​Text [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-nullDeprecated * [Market​Region​Country](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketRegionCountry) OBJECT A country which comprises a market. * code [Country​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) non-null The ISO code identifying the country. * currency [Currency​Setting!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CurrencySetting) non-null The currency which this country uses given its market settings. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the region. * [Market​Web​Presence](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketWebPresence) OBJECT The market’s web presence, which defines its SEO strategy. This can be a different domain (e.g. `example.ca`), subdomain (e.g. `ca.example.com`), or subfolders of the primary domain (e.g. `example.com/en-ca`). Each web presence comprises one or more language variants. If a market does not have its own web presence, it is accessible on the shop’s primary domain via [country selectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector). Note: while the domain/subfolders defined by a market’s web presence are not applicable to custom storefronts, which must manage their own domains and routing, the languages chosen here do govern [the languages available on the Storefront API](https://shopify.dev/custom-storefronts/internationalization/multiple-languages) for the countries in this market. * alternate​Locales [\[Shop​Locale!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopLocale) non-null The ShopLocale object for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and `example.ca` is the market’s domain, then `example.ca/en` will load in English. * default​Locale [Shop​Locale!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopLocale) non-null The ShopLocale object for the default locale. When a domain is used, this is the locale that will be used when the domain root is accessed. For example, if French is the default locale, and `example.ca` is the market’s domain, then `example.ca` will load in French. * domain [Domain](https://shopify.dev/docs/api/admin-graphql/latest/objects/Domain) The web presence’s domain. This field will be null if `subfolderSuffix` isn't null. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * markets [Market​Connection](https://shopify.dev/docs/api/admin-graphql/latest/connections/MarketConnection) The associated markets for this web presence. * root​Urls [\[Market​Web​Presence​Root​Url!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketWebPresenceRootUrl) non-null The list of root URLs for each of the web presence’s locales. As of version `2024-04` this value will no longer have a trailing slash. * subfolder​Suffix [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The market-specific suffix of the subfolders defined by the web presence. Example: in `/en-us` the subfolder suffix is `us`. This field will be null if `domain` isn't null. * market [Market](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) Deprecated * [Media​Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaImage) OBJECT The `MediaImage` object represents an image hosted on Shopify's [content delivery network (CDN)](https://shopify.dev/docs/storefronts/themes/best-practices/performance/platform#shopify-cdn). Shopify CDN is a content system that serves as the primary way to store, manage, and deliver visual content for products, variants, and other resources across the Shopify platform. The `MediaImage` object provides information to: * Store and display product and variant images across online stores, admin interfaces, and mobile apps. * Retrieve visual branding elements, including logos, banners, favicons, and background images in checkout flows. * Retrieve signed URLs for secure, time-limited access to original image files. Each `MediaImage` object provides both the processed image data (with automatic optimization and CDN delivery) and access to the original source file. The image processing is handled asynchronously, so images might not be immediately available after upload. The [`status`](https://shopify.dev/docs/api/admin-graphql/latest/objects/mediaimage#field-MediaImage.fields.status) field indicates when processing is complete and the image is ready for use. The `MediaImage` object implements the [`Media`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Media) interface alongside other media types, like videos and 3D models. Learn about managing media for [products](https://shopify.dev/docs/apps/build/online-store/product-media), [product variants](https://shopify.dev/docs/apps/build/online-store/product-variant-media), and [asynchronous media management](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components#asynchronous-media-management). * alt [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A word or phrase to share the nature or contents of a media. * 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)) when the file was created. * file​Errors [\[File​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FileError) non-null Any errors that have occurred on the file. * file​Status [File​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FileStatus) non-null The status of the file. * 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 for the media. Returns `null` until `status` is `READY`. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaContentType) non-null The media content type. * media​Errors [\[Media​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaError) non-null Any errors which have occurred on the media. * media​Warnings [\[Media​Warning!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaWarning) non-null The warnings attached to the media. * mime​Type [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The MIME type of the image. * original​Source [Media​Image​Original​Source](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaImageOriginalSource) The original source of the image. * preview [Media​Preview​Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaPreviewImage) The preview image for the media. * status [Media​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaStatus) non-null Current status of the media. * 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](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) Deprecated * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-nullDeprecated * [Menu](https://shopify.dev/docs/api/admin-graphql/latest/objects/Menu) OBJECT A menu for display on the storefront. * handle [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The menu's handle. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * is​Default [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the menu is a default. The handle for default menus can't be updated and default menus can't be deleted. * items [\[Menu​Item!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MenuItem) non-null A list of items on the menu sorted by position. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The menu's title. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) OBJECT Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin-graphql/latest/interfaces/HasMetafields). Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers. Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value. * compare​Digest [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The data stored in the resource, represented as a digest. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the metafield was created. * definition [Metafield​Definition](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition) The metafield definition that the metafield belongs to, if any. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * json​Value [JSON!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) non-null The data stored in the metafield in JSON format. * key [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique identifier for the metafield within its namespace. * 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. * namespace [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The container for a group of metafields that the metafield is associated with. * owner [Has​Metafields!](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafields) non-null The resource that the metafield is attached to. * owner​Type [Metafield​Owner​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldOwnerType) non-null The type of resource that the metafield is attached to. * reference [Metafield​Reference](https://shopify.dev/docs/api/admin-graphql/latest/unions/MetafieldReference) Returns a reference object if the metafield definition's type is a resource reference. * references [Metafield​Reference​Connection](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldReferenceConnection) A list of reference objects if the metafield's type is a resource reference list. * type [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The type of data that is stored in the metafield. Refer to the list of [supported types](https://shopify.dev/apps/metafields/types). * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the metafield was updated. * value [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The data stored in the metafield. Always stored as a string, regardless of the metafield's type. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [Metafield​Definition](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition) OBJECT Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context. * access [Metafield​Access!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldAccess) non-null The access settings associated with the metafield definition. * capabilities [Metafield​Capabilities!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldCapabilities) non-null The capabilities of the metafield definition. * constraints [Metafield​Definition​Constraints](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinitionConstraints) The [constraints](https://shopify.dev/apps/build/custom-data/metafields/conditional-metafield-definitions) that determine what subtypes of resources a metafield definition applies to. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The description of the metafield definition. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * key [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique identifier for the metafield definition within its namespace. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection) non-null The metafields that belong to the metafield definition. * metafields​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The count of the metafields that belong to the metafield definition. * validation​Status [Metafield​Validation​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldValidationStatus) ### Arguments The current validation status. *** * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The human-readable name of the metafield definition. * namespace [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The container for a group of metafields that the metafield definition is associated with. * owner​Type [Metafield​Owner​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldOwnerType) non-null The resource type that the metafield definition is attached to. * pinned​Position [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The position of the metafield definition in the pinned list. * standard​Template [Standard​Metafield​Definition​Template](https://shopify.dev/docs/api/admin-graphql/latest/objects/StandardMetafieldDefinitionTemplate) The standard metafield definition template associated with the metafield definition. * type [Metafield​Definition​Type!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinitionType) non-null The type of data that each of the metafields that belong to the metafield definition will store. Refer to the list of [supported types](https://shopify.dev/apps/metafields/types). * use​As​Collection​Condition [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the metafield definition can be used as a collection condition. * validations [\[Metafield​Definition​Validation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinitionValidation) non-null A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for the metafields that belong to the metafield definition. For example, for a metafield definition with the type `date`, you can set a minimum date validation so that each of the metafields that belong to it can only store dates after the specified minimum. * validation​Status [Metafield​Definition​Validation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldDefinitionValidationStatus) non-null The validation status for the metafields that belong to the metafield definition. * [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 * [Metaobject​Definition](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition) OBJECT Provides the definition of a generic object structure composed of metafields. * access [Metaobject​Access!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectAccess) non-null Access configuration for the metaobject definition. * capabilities [Metaobject​Capabilities!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectCapabilities) non-null The capabilities of the metaobject definition. * created​By​App [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-null The app used to create the metaobject definition. * created​By​Staff [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The staff member who created the metaobject definition. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The administrative description. * display​Name​Key [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The key of a field to reference as the display name for each object. * field​Definitions [\[Metaobject​Field​Definition!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectFieldDefinition) non-null The fields defined for this object type. * has​Thumbnail​Field [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether this metaobject definition has field whose type can visually represent a metaobject with the `thumbnailField`. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * metaobjects [Metaobject​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetaobjectConnection) non-null A paginated connection to the metaobjects associated with the definition. * metaobjects​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The count of metaobjects created for the definition. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The human-readable name. * standard​Template [Standard​Metaobject​Definition​Template](https://shopify.dev/docs/api/admin-graphql/latest/objects/StandardMetaobjectDefinitionTemplate) The standard metaobject template associated with the definition. * type [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The type of the object definition. Defines the namespace of associated metafields. * [Model3d](https://shopify.dev/docs/api/admin-graphql/latest/objects/Model3d) OBJECT Represents a Shopify hosted 3D model. * alt [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A word or phrase to describe the contents or the function of a file. * bounding​Box [Model3d​Bounding​Box](https://shopify.dev/docs/api/admin-graphql/latest/objects/Model3dBoundingBox) The 3d model's bounding box information. * 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)) when the file was created. * file​Errors [\[File​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FileError) non-null Any errors that have occurred on the file. * filename [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The 3d model's filename. * file​Status [File​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FileStatus) non-null The status of the file. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaContentType) non-null The media content type. * media​Errors [\[Media​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaError) non-null Any errors which have occurred on the media. * media​Warnings [\[Media​Warning!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaWarning) non-null The warnings attached to the media. * original​Source [Model3d​Source](https://shopify.dev/docs/api/admin-graphql/latest/objects/Model3dSource) The 3d model's original source. * preview [Media​Preview​Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaPreviewImage) The preview image for the media. * sources [\[Model3d​Source!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Model3dSource) non-null The 3d model's sources. * status [Media​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaStatus) non-null Current status of the media. * 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 file was last updated. * [Online​Store​Theme](https://shopify.dev/docs/api/admin-graphql/latest/objects/OnlineStoreTheme) OBJECT A theme for display on the storefront. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the theme was created. * files [Online​Store​Theme​File​Connection](https://shopify.dev/docs/api/admin-graphql/latest/connections/OnlineStoreThemeFileConnection) The files in the theme. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the theme, set by the merchant. * prefix [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The prefix of the theme. * processing [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the theme is processing. * processing​Failed [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the theme processing failed. * role [Theme​Role!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ThemeRole) non-null The role of the theme. * theme​Store​Id [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The theme store ID. * 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 when the theme was last updated. * [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 * [Order​Adjustment](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderAdjustment) OBJECT An order adjustment accounts for the difference between a calculated and actual refund amount. * amount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The amount of the order adjustment in shop and presentment currencies. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * reason [Order​Adjustment​Discrepancy​Reason](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderAdjustmentDiscrepancyReason) An optional reason that explains a discrepancy between calculated and actual refund amounts. * tax​Amount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The tax amount of the order adjustment in shop and presentment currencies. * [Order​Dispute​Summary](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderDisputeSummary) OBJECT A summary of the important details for a dispute on an order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * initiated​As [Dispute​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DisputeType) non-null The type that the dispute was initiated as. * status [Dispute​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DisputeStatus) non-null The current status of the dispute. * [Order​Edit​Session](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderEditSession) OBJECT An edit session for an order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID of the order edit session. * [Order​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction) OBJECT The `OrderTransaction` object represents a payment transaction that's associated with an order. An order transaction is a specific action or event that happens within the context of an order, such as a customer paying for a purchase or receiving a refund, or other payment-related activity. Use the `OrderTransaction` object to capture the complete lifecycle of a payment, from initial authorization to final settlement, including refunds and currency exchanges. Common use cases for using the `OrderTransaction` object include: * Processing new payments for orders * Managing payment authorizations and captures * Processing refunds for returned items * Tracking payment status and errors * Managing multi-currency transactions * Handling payment gateway integrations Each `OrderTransaction` object has a [`kind`](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderTransactionKind) that defines the type of transaction and a [`status`](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderTransactionStatus) that indicates the current state of the transaction. The object stores detailed information about payment methods, gateway processing, and settlement details. Learn more about [payment processing](https://help.shopify.com/manual/payments) and [payment gateway integrations](https://www.shopify.com/ca/payment-gateways). * account​Number [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The masked account number associated with the payment method. * amount​Rounding​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) The rounding adjustment applied on the cash amount in shop and presentment currencies. * amount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The amount and currency of the transaction in shop and presentment currencies. * authorization​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Authorization code associated with the transaction. * authorization​Expires​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The time when the authorization expires. This field is available only to stores on a Shopify Plus plan. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null Date and time when the transaction was created. * currency​Exchange​Adjustment [Currency​Exchange​Adjustment](https://shopify.dev/docs/api/admin-graphql/latest/objects/CurrencyExchangeAdjustment) An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. * device [Point​Of​Sale​Device](https://shopify.dev/docs/api/admin-graphql/latest/objects/PointOfSaleDevice) The Shopify Point of Sale device used to process the transaction. * error​Code [Order​Transaction​Error​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderTransactionErrorCode) A standardized error code, independent of the payment provider. * fees [\[Transaction​Fee!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TransactionFee) non-null The transaction fees charged on the order transaction. Only present for Shopify Payments transactions. * formatted​Gateway [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The human-readable payment gateway name used to process the transaction. * gateway [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The payment gateway used to process the transaction. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * kind [Order​Transaction​Kind!](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderTransactionKind) non-null The kind of transaction. * location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) The physical location where the transaction was processed. * manually​Capturable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the transaction can be manually captured. * manual​Payment​Gateway [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the transaction is processed by manual payment gateway. * maximum​Refundable​V2 [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) Specifies the available amount with currency to refund on the gateway. This value is only available for transactions of type `SuggestedRefund`. * multi​Capturable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the transaction can be captured multiple times. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The associated order. * parent​Transaction [Order​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction) The associated parent transaction, for example the authorization of a capture. * payment​Details [Payment​Details](https://shopify.dev/docs/api/admin-graphql/latest/unions/PaymentDetails) The payment details for the transaction. * payment​Icon [Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) The payment icon to display for the transaction. * payment​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The payment ID associated with the transaction. * processed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) Date and time when the transaction was processed. * receipt​Json [JSON](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. * settlement​Currency [Currency​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) The settlement currency. * settlement​Currency​Rate [Decimal](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Decimal) The rate used when converting the transaction amount to settlement currency. * shopify​Payments​Set [Shopify​Payments​Transaction​Set](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsTransactionSet) Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan. * status [Order​Transaction​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/OrderTransactionStatus) non-null The status of this transaction. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the transaction is a test transaction. * total​Unsettled​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) Specifies the available amount with currency to capture on the gateway in shop and presentment currencies. Only available when an amount is capturable or manually mark as paid. * user [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) Staff member who was logged into the Shopify POS device when the transaction was processed. * amount [Money!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) non-nullDeprecated * amount​V2 [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-nullDeprecated * maximum​Refundable [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) Deprecated * payment​Method [Payment​Methods](https://shopify.dev/docs/api/admin-graphql/latest/enums/PaymentMethods) Deprecated * total​Unsettled [Money](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Money) Deprecated * total​Unsettled​V2 [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) Deprecated * [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 * [Payment​Mandate](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentMandate) OBJECT A payment instrument and the permission the owner of the instrument gives to the merchant to debit it. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID of a payment mandate. * payment​Instrument [Payment​Instrument!](https://shopify.dev/docs/api/admin-graphql/latest/unions/PaymentInstrument) non-null The outputs details of the payment instrument. * [Payment​Schedule](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentSchedule) OBJECT Represents the payment schedule for a single payment defined in the payment terms. * balance​Due [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null Remaining balance to be captured for this payment schedule. * completed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) Date and time when the payment schedule is paid or fulfilled. * due [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the payment schedule is due. * due​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) Date and time when the payment schedule is due. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * issued​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) Date and time when the invoice is sent. * payment​Terms [Payment​Terms!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms) non-null The payment terms the payment schedule belongs to. * total​Balance [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null Remaining balance to be paid or authorized by the customer for this payment schedule. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-nullDeprecated * [Payment​Terms](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms) OBJECT Represents the payment terms for an order or draft order. * draft​Order [Draft​Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder) The draft order associated with the payment terms. * due [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether payment terms have a payment schedule that's due. * due​In​Days [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) Duration of payment terms in days based on the payment terms template used to create the payment terms. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The order associated with the payment terms. * overdue [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the payment terms have overdue payment schedules. * payment​Schedules [Payment​Schedule​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PaymentScheduleConnection) non-null List of schedules for the payment terms. * payment​Terms​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the payment terms template used to create the payment terms. * payment​Terms​Type [Payment​Terms​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/PaymentTermsType) non-null The payment terms template type used to create the payment terms. * translated​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The payment terms name, translated into the shop admin's preferred language. * [Payment​Terms​Template](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTermsTemplate) OBJECT Represents the payment terms template object. * description [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The description of the payment terms template. * due​In​Days [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The number of days between the issued date and due date if this is the net type of payment terms. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the payment terms template. * payment​Terms​Type [Payment​Terms​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/PaymentTermsType) non-null The type of the payment terms template. * translated​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The translated payment terms template name. * [Point​Of​Sale​Device](https://shopify.dev/docs/api/admin-graphql/latest/objects/PointOfSaleDevice) OBJECT Represents a mobile device that Shopify Point of Sale has been installed on. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * [Price​List](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) OBJECT Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility. For more information on price lists, refer to [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists). * catalog [Catalog](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) The catalog that the price list is associated with. * currency [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The currency for fixed prices associated with this price list. * fixed​Prices​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of fixed prices on the price list. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The unique name of the price list, used as a human-readable identifier. * parent [Price​List​Parent](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceListParent) Relative adjustments to other prices. * prices [Price​List​Price​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PriceListPriceConnection) non-null A list of prices associated with the price list. * quantity​Rules [Quantity​Rule​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/QuantityRuleConnection) non-null A list of quantity rules associated with the price list, ordered by product variants. * [Price​Rule](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRule) OBJECT Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources. * allocation​Limit [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The maximum number of times that the price rule can be allocated onto an order. * allocation​Method [Price​Rule​Allocation​Method!](https://shopify.dev/docs/api/admin-graphql/latest/enums/PriceRuleAllocationMethod) non-null The method by which the price rule's value is allocated to its entitled items. * app [App](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) The application that created the price rule. * combines​With [Discount​Combines​With!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCombinesWith) non-null The [discount classes](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types). * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the price rule was created. * customer​Selection [Price​Rule​Customer​Selection!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleCustomerSelection) non-null The customers that can use this price rule. * discount​Classes [\[Discount​Class!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass) non-null The classes of the discount. * discount​Codes [Price​Rule​Discount​Code​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PriceRuleDiscountCodeConnection) non-null List of the price rule's discount codes. * discount​Codes​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) How many discount codes associated with the price rule. * ends​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the price rule ends. For open-ended price rules, use `null`. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection) non-null The paginated list of events associated with the price rule. * features [\[Price​Rule​Feature!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/PriceRuleFeature) non-null A list of the price rule's features. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Indicates whether there are any timeline comments on the price rule. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * item​Entitlements [Price​Rule​Item​Entitlements!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleItemEntitlements) non-null The items to which the price rule applies. * item​Prerequisites [Price​Rule​Line​Item​Prerequisites!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleLineItemPrerequisites) non-null The items required for the price rule to be applicable. * 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. * once​Per​Customer [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the price rule can be applied only once per customer. * prerequisite​Quantity​Range [Price​Rule​Quantity​Range](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleQuantityRange) The number of the entitled items must fall within this range for the price rule to be applicable. * prerequisite​Shipping​Price​Range [Price​Rule​Money​Range](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleMoneyRange) The shipping cost must fall within this range for the price rule to be applicable. * prerequisite​Subtotal​Range [Price​Rule​Money​Range](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleMoneyRange) The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. * prerequisite​To​Entitlement​Quantity​Ratio [Price​Rule​Prerequisite​To​Entitlement​Quantity​Ratio](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRulePrerequisiteToEntitlementQuantityRatio) Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. * shareable​Urls [\[Price​Rule​Shareable​Url!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleShareableUrl) non-null URLs that can be used to share the discount. * shipping​Entitlements [Price​Rule​Shipping​Line​Entitlements!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleShippingLineEntitlements) non-null The shipping lines to which the price rule applies. * starts​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the price rule starts. * status [Price​Rule​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/PriceRuleStatus) non-null The status of the price rule. * summary [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A detailed summary of the price rule. * target [Price​Rule​Target!](https://shopify.dev/docs/api/admin-graphql/latest/enums/PriceRuleTarget) non-null The type of lines (line\_item or shipping\_line) to which the price rule applies. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The title of the price rule. * total​Sales [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The total sales from orders where the price rule was used. * usage​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. * usage​Limit [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The maximum number of times that the price rule can be used in total. * validity​Period [Price​Rule​Validity​Period!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleValidityPeriod) non-null A time period during which a price rule is applicable. * value​V2 [Pricing​Value!](https://shopify.dev/docs/api/admin-graphql/latest/unions/PricingValue) non-null The value of the price rule. * discount​Class [Discount​Class!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DiscountClass) non-nullDeprecated * entitlement​To​Prerequisite​Quantity​Ratio [Price​Rule​Entitlement​To​Prerequisite​Quantity​Ratio](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleEntitlementToPrerequisiteQuantityRatio) Deprecated * traits [\[Price​Rule​Trait!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/PriceRuleTrait) non-nullDeprecated * value [Price​Rule​Value!](https://shopify.dev/docs/api/admin-graphql/latest/unions/PriceRuleValue) non-nullDeprecated * [Price​Rule​Discount​Code](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRuleDiscountCode) OBJECT A discount code of a price rule. * app [App](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) The application that created the discount code. * code [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The code to apply the discount. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * usage​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. * [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​Bundle​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductBundleOperation) OBJECT An entity that represents details of an asynchronous [ProductBundleCreate](https://shopify.dev/api/admin-graphql/current/mutations/productBundleCreate) or [ProductBundleUpdate](https://shopify.dev/api/admin-graphql/current/mutations/productBundleUpdate) mutation. By querying this entity with the [productOperation](https://shopify.dev/api/admin-graphql/current/queries/productOperation) query using the ID that was returned when the bundle was created or updated, this can be used to check the status of an operation. The `status` field indicates whether the operation is `CREATED`, `ACTIVE`, or `COMPLETE`. The `product` field provides the details of the created or updated product. The `userErrors` field provides mutation errors that occurred during the operation. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) The product on which the operation is being performed. * status [Product​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductOperationStatus) non-null The status of this operation. * user​Errors [\[Product​Bundle​Mutation​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductBundleMutationUserError) non-null Returns mutation errors occurred during background mutation processing. * [Product​Delete​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductDeleteOperation) OBJECT An entity that represents details of an asynchronous [ProductDelete](https://shopify.dev/api/admin-graphql/current/mutations/productDelete) mutation. By querying this entity with the [productOperation](https://shopify.dev/api/admin-graphql/current/queries/productOperation) query using the ID that was returned when the product was deleted, this can be used to check the status of an operation. The `status` field indicates whether the operation is `CREATED`, `ACTIVE`, or `COMPLETE`. The `deletedProductId` field provides the ID of the deleted product. The `userErrors` field provides mutation errors that occurred during the operation. * deleted​Product​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) The ID of the deleted product. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) The product on which the operation is being performed. * status [Product​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductOperationStatus) non-null The status of this operation. * user​Errors [\[User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/UserError) non-null Returns mutation errors occurred during background mutation processing. * [Product​Duplicate​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductDuplicateOperation) OBJECT An entity that represents details of an asynchronous [ProductDuplicate](https://shopify.dev/api/admin-graphql/current/mutations/productDuplicate) mutation. By querying this entity with the [productOperation](https://shopify.dev/api/admin-graphql/current/queries/productOperation) query using the ID that was returned [when the product was duplicated](https://shopify.dev/api/admin/migrate/new-product-model/sync-data#create-a-product-with-variants-and-options-asynchronously), this can be used to check the status of an operation. The `status` field indicates whether the operation is `CREATED`, `ACTIVE`, or `COMPLETE`. The `product` field provides the details of the original product. The `newProduct` field provides the details of the new duplicate of the product. The `userErrors` field provides mutation errors that occurred during the operation. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * new​Product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) The newly created duplicate of the original product. * product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) The product on which the operation is being performed. * status [Product​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductOperationStatus) non-null The status of this operation. * user​Errors [\[User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/UserError) non-null Returns mutation errors occurred during background mutation processing. * [Product​Feed](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductFeed) OBJECT A product feed. * country [Country​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The country of the product feed. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * language [Language​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/LanguageCode) The language of the product feed. * status [Product​Feed​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductFeedStatus) non-null The status of the product feed. * [Product​Option](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption) OBJECT The product property names. For example, "Size", "Color", and "Material". Variants are selected based on permutations of these options. The limit for each product property name is 255 characters. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * linked​Metafield [Linked​Metafield](https://shopify.dev/docs/api/admin-graphql/latest/objects/LinkedMetafield) The metafield identifier linked to this option. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The product option’s name. * option​Values [\[Product​Option​Value!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValue) non-null Similar to values, option\_values returns all the corresponding option value objects to the product option, including values not assigned to any variants. * position [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The product option's position. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * values [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The corresponding value to the product option name. * [Product​Option​Value](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValue) OBJECT The product option value names. For example, "Red", "Blue", and "Green" for a "Color" option. * has​Variants [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the product option value has any linked variants. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * linked​Metafield​Value [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The value of the linked metafield. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the product option value. * swatch [Product​Option​Value​Swatch](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValueSwatch) The swatch associated with the product option value. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * [Product​Set​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductSetOperation) OBJECT An entity that represents details of an asynchronous [ProductSet](https://shopify.dev/api/admin-graphql/current/mutations/productSet) mutation. By querying this entity with the [productOperation](https://shopify.dev/api/admin-graphql/current/queries/productOperation) query using the ID that was returned [when the product was created or updated](https://shopify.dev/api/admin/migrate/new-product-model/sync-data#create-a-product-with-variants-and-options-asynchronously), this can be used to check the status of an operation. The `status` field indicates whether the operation is `CREATED`, `ACTIVE`, or `COMPLETE`. The `product` field provides the details of the created or updated product. The `userErrors` field provides mutation errors that occurred during the operation. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * product [Product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) The product on which the operation is being performed. * status [Product​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductOperationStatus) non-null The status of this operation. * user​Errors [\[Product​Set​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductSetUserError) non-null Returns mutation errors occurred during background mutation processing. * [Product​Taxonomy​Node](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductTaxonomyNode) OBJECT Represents a [Shopify product taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17) node. * full​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of the product taxonomy node. * is​Leaf [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the node is a leaf node. * is​Root [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the node is a root node. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the product taxonomy node. For example, Dog Beds. * [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 * [Product​Variant​Component](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariantComponent) OBJECT A product variant component that is included within a bundle. These are the individual product variants that make up a bundle product, where each component has a specific required quantity. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * product​Variant [Product​Variant!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) non-null The product variant associated with the component. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The required quantity of the component. * [Publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) OBJECT A publication is a group of products and collections that is published to an app. * auto​Publish [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether new products are automatically published to this publication. * catalog [Catalog](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) The catalog associated with the publication. * collection​Publications​V3 [Resource​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection) non-null The list of collection publication records, each representing the publication status and details for a collection published to this publication (typically channel). * collections [Collection​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/CollectionConnection) non-null The list of collections published to the publication. * has​Collection [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the collection is available to the publication. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments Collection ID to check. *** * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * included​Products [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-null The list of products included, but not necessarily published, in the publication. * included​Products​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The count of products included in the publication. Limited to a maximum of 10000 by default. * operation [Publication​Operation](https://shopify.dev/docs/api/admin-graphql/latest/unions/PublicationOperation) A background operation associated with this publication. * product​Publications​V3 [Resource​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection) non-null The product publications for the list of products published to the publication. * products [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-null The list of products published to the publication. * supports​Future​Publishing [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the publication supports future publishing. * app [App!](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) non-nullDeprecated * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-nullDeprecated * [Publication​Resource​Operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/PublicationResourceOperation) OBJECT A bulk update operation on a publication. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * processed​Row​Count [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The count of processed rows, summing imported, failed, and skipped rows. * row​Count [Row​Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/RowCount) Represents a rows objects within this background operation. * status [Resource​Operation​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ResourceOperationStatus) non-null The status of this operation. * [Quantity​Price​Break](https://shopify.dev/docs/api/admin-graphql/latest/objects/QuantityPriceBreak) OBJECT Quantity price breaks lets you offer different rates that are based on the amount of a specific variant being ordered. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * minimum​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null Minimum quantity required to reach new quantity break price. * price [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The price of variant after reaching the minimum quanity. * price​List [Price​List!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) non-null The price list associated with this quantity break. * variant [Product​Variant!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) non-null The product variant associated with this quantity break. * [Refund](https://shopify.dev/docs/api/admin-graphql/latest/objects/Refund) OBJECT The `Refund` object represents a financial record of money returned to a customer from an order. It provides a comprehensive view of all refunded amounts, transactions, and restocking instructions associated with returning products or correcting order issues. The `Refund` object provides information to: * Process customer returns and issue payments back to customers * Handle partial or full refunds for line items with optional inventory restocking * Refund shipping costs, duties, and additional fees * Issue store credit refunds as an alternative to original payment method returns * Track and reconcile all financial transactions related to refunds Each `Refund` object maintains detailed records of what was refunded, how much was refunded, which payment transactions were involved, and any inventory restocking that occurred. The refund can include multiple components such as product line items, shipping charges, taxes, duties, and additional fees, all calculated with proper currency handling for international orders. Refunds are always associated with an [order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) and can optionally be linked to a [return](https://shopify.dev/docs/api/admin-graphql/latest/objects/Return) if the refund was initiated through the returns process. The refund tracks both the presentment currency (what the customer sees) and the shop currency for accurate financial reporting. *** Note The existence of a `Refund` object doesn't guarantee that the money has been returned to the customer. The actual financial processing happens through associated [`OrderTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction) objects, which can be in various states, such as pending, processing, success, or failure. To determine if money has actually been refunded, check the [status](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction#field-OrderTransaction.fields.status) of the associated transactions. *** Learn more about [managing returns](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management), [refunding duties](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/view-and-refund-duties), and [processing refunds](https://shopify.dev/docs/api/admin-graphql/latest/mutations/refundCreate). * created​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the refund was created. * duties [\[Refund​Duty!\]](https://shopify.dev/docs/api/admin-graphql/latest/objects/RefundDuty) A list of the refunded duties as part of this refund. * 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. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The optional note associated with the refund. * order [Order!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) non-null The order associated with the refund. * order​Adjustments [Order​Adjustment​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderAdjustmentConnection) non-null The order adjustments that are attached with the refund. * refund​Line​Items [Refund​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/RefundLineItemConnection) non-null The `RefundLineItem` resources attached to the refund. * refund​Shipping​Lines [Refund​Shipping​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/RefundShippingLineConnection) non-null The `RefundShippingLine` resources attached to the refund. * return [Return](https://shopify.dev/docs/api/admin-graphql/latest/objects/Return) The return associated with the refund. * staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The staff member who created the refund. * total​Refunded​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total amount across all transactions for the refund, in shop and presentment currencies. * transactions [Order​Transaction​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderTransactionConnection) non-null The transactions associated with the refund. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the refund was updated. * total​Refunded [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-nullDeprecated * [Refund​Shipping​Line](https://shopify.dev/docs/api/admin-graphql/latest/objects/RefundShippingLine) OBJECT A shipping line item that's included in a refund. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * shipping​Line [Shipping​Line!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShippingLine) non-null The `ShippingLine` resource associated to the refunded shipping line item. * subtotal​Amount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The subtotal amount of the refund shipping line in shop and presentment currencies. * tax​Amount​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The tax amount of the refund shipping line in shop and presentment currencies. * [Return](https://shopify.dev/docs/api/admin-graphql/latest/objects/Return) OBJECT The `Return` object represents the intent of a buyer to ship one or more items from an order back to a merchant or a third-party fulfillment location. A return is associated with an [order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) and can include multiple return [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem). Each return has a [status](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps#return-statuses), which indicates the state of the return. Use the `Return` object to capture the financial, logistical, and business intent of a return. For example, you can identify eligible items for a return and issue customers a refund for returned items on behalf of the merchant. Learn more about providing a [return management workflow](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management) for merchants. You can also manage [exchanges](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-exchanges), [reverse fulfillment orders](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-reverse-fulfillment-orders), and [reverse deliveries](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-reverse-deliveries) on behalf of merchants. * closed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the return was closed. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the return was created. * decline [Return​Decline](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReturnDecline) Additional information about the declined return. * exchange​Line​Items [Exchange​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ExchangeLineItemConnection) non-null The exchange line items attached to the return. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the return. * order [Order!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) non-null The order that the return belongs to. * refunds [Refund​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/RefundConnection) non-null The list of refunds associated with the return. * request​Approved​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the return was approved. * return​Line​Items [Return​Line​Item​Type​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReturnLineItemTypeConnection) non-null The return line items attached to the return. * return​Shipping​Fees [\[Return​Shipping​Fee!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReturnShippingFee) non-null The return shipping fees for the return. * reverse​Fulfillment​Orders [Reverse​Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReverseFulfillmentOrderConnection) non-null The list of reverse fulfillment orders for the return. * status [Return​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ReturnStatus) non-null The status of the return. * suggested​Financial​Outcome [Suggested​Return​Financial​Outcome](https://shopify.dev/docs/api/admin-graphql/latest/objects/SuggestedReturnFinancialOutcome) A suggested financial outcome for the return. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The sum of all return line item quantities for the return. * suggested​Refund [Suggested​Return​Refund](https://shopify.dev/docs/api/admin-graphql/latest/objects/SuggestedReturnRefund) Deprecated * [Returnable​Fulfillment](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReturnableFulfillment) OBJECT A returnable fulfillment, which is an order that has been delivered and is eligible to be returned to the merchant. * fulfillment [Fulfillment!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Fulfillment) non-null The fulfillment that the returnable fulfillment refers to. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID of the Returnable Fulfillment. * returnable​Fulfillment​Line​Items [Returnable​Fulfillment​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReturnableFulfillmentLineItemConnection) non-null The list of returnable fulfillment line items. * [Return​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReturnLineItem) OBJECT A return line item. * customer​Note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note from the customer that describes the item to be returned. Maximum length: 300 characters. * fulfillment​Line​Item [Fulfillment​Line​Item!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentLineItem) non-null The fulfillment line item from which items are returned. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * processable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that can be processed. * processed​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that has been processed. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity being returned. * refundable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that can be refunded. * refunded​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that was refunded. * restocking​Fee [Restocking​Fee](https://shopify.dev/docs/api/admin-graphql/latest/objects/RestockingFee) The restocking fee for the return line item. * return​Reason [Return​Reason!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ReturnReason) non-null The reason for returning the item. * return​Reason​Note [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Additional information about the reason for the return. Maximum length: 255 characters. * total​Weight [Weight](https://shopify.dev/docs/api/admin-graphql/latest/objects/Weight) The total weight of the item. * unprocessed​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that has't been processed. * with​Code​Discounted​Total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The total line price after all discounts on the line item, including both line item level discounts and code-based line item discounts, are applied. * [Reverse​Delivery](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseDelivery) OBJECT A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant. For example, a buyer requests a return, and a merchant sends the buyer a shipping label. The reverse delivery contains the context of the items sent back, how they're being sent back (for example, a shipping label), and the current state of the delivery (tracking information). * deliverable [Reverse​Delivery​Deliverable](https://shopify.dev/docs/api/admin-graphql/latest/unions/ReverseDeliveryDeliverable) The deliverable associated with the reverse delivery. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of the reverse delivery. * reverse​Delivery​Line​Items [Reverse​Delivery​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReverseDeliveryLineItemConnection) non-null The reverse delivery line items attached to the reverse delivery. * reverse​Fulfillment​Order [Reverse​Fulfillment​Order!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrder) non-null The `ReverseFulfillmentOrder` associated with the reverse delivery. * [Reverse​Delivery​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseDeliveryLineItem) OBJECT The details about a reverse delivery line item. * dispositions [\[Reverse​Fulfillment​Order​Disposition!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrderDisposition) non-null The dispositions of the item. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The expected number of units. * reverse​Fulfillment​Order​Line​Item [Reverse​Fulfillment​Order​Line​Item!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrderLineItem) non-null The corresponding reverse fulfillment order line item. * [Reverse​Fulfillment​Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrder) OBJECT A group of one or more items in a return that will be processed at a fulfillment service. There can be more than one reverse fulfillment order for a return at a given location. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * line​Items [Reverse​Fulfillment​Order​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReverseFulfillmentOrderLineItemConnection) non-null The list of reverse fulfillment order line items for the reverse fulfillment order. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The order associated with the reverse fulfillment order. * reverse​Deliveries [Reverse​Delivery​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ReverseDeliveryConnection) non-null The list of reverse deliveries for the reverse fulfillment order. * status [Reverse​Fulfillment​Order​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ReverseFulfillmentOrderStatus) non-null The status of the reverse fulfillment order. * third​Party​Confirmation [Reverse​Fulfillment​Order​Third​Party​Confirmation](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrderThirdPartyConfirmation) The current confirmation for the reverse fulfillment order from a third-party logistics service. If no third-party service is involved, then this value is `nil`. * [Reverse​Fulfillment​Order​Disposition](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrderDisposition) OBJECT The details of the arrangement of an item. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the disposition was created. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * location [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) The location where the disposition occurred. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The number of disposed units. * type [Reverse​Fulfillment​Order​Disposition​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ReverseFulfillmentOrderDispositionType) non-null The final arrangement of an item. * [Reverse​Fulfillment​Order​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrderLineItem) OBJECT The details about a reverse fulfillment order line item. * dispositions [\[Reverse​Fulfillment​Order​Disposition!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReverseFulfillmentOrderDisposition) non-null The dispositions of the item. * fulfillment​Line​Item [Fulfillment​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentLineItem) The corresponding fulfillment line item for a reverse fulfillment order line item. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The total number of units to be processed. * [Sale​Additional​Fee](https://shopify.dev/docs/api/admin-graphql/latest/objects/SaleAdditionalFee) OBJECT The additional fee details for a line item. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the additional fee. * price [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyBag) non-null The price of the additional fee. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxLine) non-null A list of taxes charged on the additional fee. * [Saved​Search](https://shopify.dev/docs/api/admin-graphql/latest/objects/SavedSearch) OBJECT A saved search is a representation of a search query saved in the admin. * filters [\[Search​Filter!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SearchFilter) non-null The filters of a saved search. * 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. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of a saved search. * query [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The query string of a saved search. This includes search terms and filters. * resource​Type [Search​Result​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/SearchResultType) non-null The type of resource this saved search is searching in. * search​Terms [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The search terms of a saved search. * [Script​Tag](https://shopify.dev/docs/api/admin-graphql/latest/objects/ScriptTag) OBJECT Theme app extensions If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. [Learn more](https://shopify.dev/apps/online-store#what-integration-method-should-i-use). Script tag deprecation Script tags will be sunset for the **Order status** page on August 28, 2025. [Upgrade to Checkout Extensibility](https://www.shopify.com/plus/upgrading-to-checkout-extensibility) before this date. [Shopify Scripts](https://shopify.dev/docs/api/liquid/objects#script) will continue to work alongside Checkout Extensibility until August 28, 2025. A script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the **Order status** page of checkout. * cache [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the Shopify CDN can cache and serve the script tag. If `true`, then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If `false`, then the script will be served as is. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the script tag was created. * display​Scope [Script​Tag​Display​Scope!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ScriptTagDisplayScope) non-null The page or pages on the online store that the script should be included. * 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. * src [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL to the remote script. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the script tag was last updated. * [Segment](https://shopify.dev/docs/api/admin-graphql/latest/objects/Segment) OBJECT A dynamic collection of customers based on specific criteria. * creation​Date [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the segment was added to the store. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * last​Edit​Date [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the segment was last updated. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the segment. * query [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers. * [Selling​Plan](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlan) OBJECT Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. For more information on selling plans, refer to [*Creating and managing selling plans*](https://shopify.dev/docs/apps/selling-strategies/subscriptions/selling-plans). * billing​Policy [Selling​Plan​Billing​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/unions/SellingPlanBillingPolicy) non-null A selling plan policy which describes the recurring billing details. * category [Selling​Plan​Category](https://shopify.dev/docs/api/admin-graphql/latest/enums/SellingPlanCategory) The category used to classify the selling plan for reporting purposes. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the selling plan was created. * delivery​Policy [Selling​Plan​Delivery​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/unions/SellingPlanDeliveryPolicy) non-null A selling plan policy which describes the delivery details. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Buyer facing string which describes the selling plan commitment. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * inventory​Policy [Selling​Plan​Inventory​Policy](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanInventoryPolicy) When to reserve inventory for a selling plan. * 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 A customer-facing description of the selling plan. If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies. * options [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. * position [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) Relative position of the selling plan for display. A lower position will be displayed before a higher position. * pricing​Policies [\[Selling​Plan​Pricing​Policy!\]!](https://shopify.dev/docs/api/admin-graphql/latest/unions/SellingPlanPricingPolicy) non-null Selling plan pricing details. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Selling​Plan​Group](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanGroup) OBJECT Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. * app​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The ID for app, exposed in Liquid and product JSON. * applies​To​Product [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the given product is directly associated to the selling plan group. * product​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the product. *** * applies​To​Product​Variant [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the given product variant is directly associated to the selling plan group. * product​Variant​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the product. *** * applies​To​Product​Variants [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether any of the product variants of the given product are associated to the selling plan group. * product​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the product. *** * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the selling plan group was created. * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The merchant-facing description of the selling plan group. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * merchant​Code [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The merchant-facing label of the selling plan group. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The buyer-facing label of the selling plan group. * options [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. * position [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The relative position of the selling plan group for display. * products [Product​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection) non-null Products associated to the selling plan group. * products​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) A count of products associated to the selling plan group. * product​Variants [Product​Variant​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductVariantConnection) non-null Product variants associated to the selling plan group. * product​Variants​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) A count of product variants associated to the selling plan group. * selling​Plans [Selling​Plan​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SellingPlanConnection) non-null Selling plans associated to the selling plan group. * summary [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A summary of the policies associated to the selling plan group. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * [Server​Pixel](https://shopify.dev/docs/api/admin-graphql/latest/objects/ServerPixel) OBJECT A server pixel stores configuration for streaming customer interactions to an EventBridge or PubSub endpoint. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * status [Server​Pixel​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/ServerPixelStatus) The current state of this server pixel. * webhook​Endpoint​Address [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Address of the EventBridge or PubSub endpoint. * [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 * [Shop​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress) OBJECT An address for a shop. * address1 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The first line of the address. Typically the street address or PO Box number. * address2 [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The second line of the address. Typically the number of the apartment, suite, or unit. * city [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the city, district, village, or town. * company [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the company or organization. * coordinates​Validated [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the address coordinates are valid. * country [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the country. * country​Code​V2 [Country​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) The two-letter code for the country of the address. For example, US. * formatted [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A formatted version of the address, customized by the provided arguments. * with​Company [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:true ### Arguments Whether to include the company in the formatted address. *** * formatted​Area [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A comma-separated list of the values for city, province, and country. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * latitude [Float](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) The latitude coordinate of the address. * longitude [Float](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) The longitude coordinate of the address. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A phone number associated with the address. Formatted using E.164 standard. For example, *+16135551111*. * province [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The region of the address, such as the province, state, or district. * province​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The alphanumeric code for the region. For example, ON. * zip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The zip or postal code of the address. * country​Code [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * first​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * last​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [Shopify​Payments​Account](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsAccount) OBJECT Balance and payout information for a [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. * account​Opener​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the account opener. * activated [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the Shopify Payments setup is completed. * balance [\[Money​V2!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null Current balances in all currencies for the account. * balance​Transactions [Shopify​Payments​Balance​Transaction​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ShopifyPaymentsBalanceTransactionConnection) non-null A list of balance transactions associated with the shop. * bank​Accounts [Shopify​Payments​Bank​Account​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ShopifyPaymentsBankAccountConnection) non-null All bank accounts configured for the Shopify Payments account. * charge​Statement​Descriptors [Shopify​Payments​Charge​Statement​Descriptor](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/ShopifyPaymentsChargeStatementDescriptor) The statement descriptors used for charges. These descriptors appear on a customer's credit card or bank statement when they make a purchase. * country [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The Shopify Payments account country. * default​Currency [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The default payout currency for the Shopify Payments account. * disputes [Shopify​Payments​Dispute​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ShopifyPaymentsDisputeConnection) non-null All disputes that originated from a transaction made with the Shopify Payments account. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * onboardable [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the Shopify Payments account can be onboarded. * payouts [Shopify​Payments​Payout​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ShopifyPaymentsPayoutConnection) non-null All current and previous payouts made between the account and the bank account. * payout​Schedule [Shopify​Payments​Payout​Schedule!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayoutSchedule) non-null The payout schedule for the account. * payout​Statement​Descriptor [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The descriptor used for payouts. The descriptor appears on a merchant's bank statement when they receive a payout. * charge​Statement​Descriptor [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [Shopify​Payments​Balance​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBalanceTransaction) OBJECT A transaction that contributes to a Shopify Payments account balance. * adjustment​Reason [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The reason for the adjustment that's associated with the transaction. If the source\_type isn't an adjustment, the value will be null. * adjustments​Orders [\[Shopify​Payments​Adjustment​Order!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsAdjustmentOrder) non-null The adjustment orders associated to the transaction. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount contributing to the balance transaction. * associated​Order [Shopify​Payments​Associated​Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsAssociatedOrder) The associated order for the balance transaction. * associated​Payout [Shopify​Payments​Balance​Transaction​Associated​Payout!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBalanceTransactionAssociatedPayout) non-null Payout assoicated with the transaction. * fee [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The fee amount contributing to the balance transaction. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * net [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The net amount contributing to the merchant's balance. * source​Id [Big​Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/BigInt) The ID of the resource leading to the transaction. * source​Order​Transaction​Id [Big​Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/BigInt) The id of the [Order Transaction](https://shopify.dev/docs/admin-api/rest/reference/orders/transaction) that resulted in this balance transaction. * source​Type [Shopify​Payments​Source​Type](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsSourceType) The source type of the balance transaction. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Wether the tranaction was created in test mode. * transaction​Date [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the balance transaction was processed. * type [Shopify​Payments​Transaction​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsTransactionType) non-null The type of transaction. * [Shopify​Payments​Bank​Account](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBankAccount) OBJECT A bank account that can receive payouts. * account​Number​Last​Digits [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The last digits of the account number (the rest is redacted). * bank​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The name of the bank. * country [Country​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CountryCode) non-null The country of the bank. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date that the bank account was created. * currency [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The currency of the bank account. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * payouts [Shopify​Payments​Payout​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ShopifyPaymentsPayoutConnection) non-null All current and previous payouts made between the account and the bank account. * status [Shopify​Payments​Bank​Account​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsBankAccountStatus) non-null The status of the bank account. * [Shopify​Payments​Dispute](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDispute) OBJECT A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The total amount disputed by the cardholder. * dispute​Evidence [Shopify​Payments​Dispute​Evidence!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeEvidence) non-null The evidence associated with the dispute. * evidence​Due​By [Date](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Date) The deadline for evidence submission. * evidence​Sent​On [Date](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Date) The date when evidence was sent. Returns null if evidence hasn't yet been sent. * finalized​On [Date](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Date) The date when this dispute was resolved. Returns null if the dispute isn't yet resolved. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * initiated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date when this dispute was initiated. * 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. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The order that contains the charge that's under dispute. * reason​Details [Shopify​Payments​Dispute​Reason​Details!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeReasonDetails) non-null The reason of the dispute. * status [Dispute​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DisputeStatus) non-null The current state of the dispute. * type [Dispute​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/DisputeType) non-null Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. * [Shopify​Payments​Dispute​Evidence](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeEvidence) OBJECT The evidence associated with the dispute. * access​Activity​Log [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The activity logs associated with the dispute evidence. * billing​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The billing address that's provided by the customer. * cancellation​Policy​Disclosure [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The cancellation policy disclosure associated with the dispute evidence. * cancellation​Policy​File [Shopify​Payments​Dispute​File​Upload](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) The cancellation policy file associated with the dispute evidence. * cancellation​Rebuttal [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The cancellation rebuttal associated with the dispute evidence. * customer​Communication​File [Shopify​Payments​Dispute​File​Upload](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) The customer communication file associated with the dispute evidence. * customer​Email​Address [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer's email address. * customer​First​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer's first name. * customer​Last​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer's last name. * customer​Purchase​Ip [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The customer purchase ip for this dispute evidence. * dispute [Shopify​Payments​Dispute!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDispute) non-null The dispute associated with the evidence. * dispute​File​Uploads [\[Shopify​Payments​Dispute​File​Upload!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) non-null The file uploads associated with the dispute evidence. * fulfillments [\[Shopify​Payments​Dispute​Fulfillment!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFulfillment) non-null The fulfillments associated with the dispute evidence. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * product​Description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The product description for this dispute evidence. * refund​Policy​Disclosure [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The refund policy disclosure associated with the dispute evidence. * refund​Policy​File [Shopify​Payments​Dispute​File​Upload](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) The refund policy file associated with the dispute evidence. * refund​Refusal​Explanation [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The refund refusal explanation associated with dispute evidence. * service​Documentation​File [Shopify​Payments​Dispute​File​Upload](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) The service documentation file associated with the dispute evidence. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) The mailing address for shipping that's provided by the customer. * shipping​Documentation​File [Shopify​Payments​Dispute​File​Upload](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) The shipping documentation file associated with the dispute evidence. * submitted [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the dispute evidence is submitted. * uncategorized​File [Shopify​Payments​Dispute​File​Upload](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) The uncategorized file associated with the dispute evidence. * uncategorized​Text [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The uncategorized text for the dispute evidence. * [Shopify​Payments​Dispute​File​Upload](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFileUpload) OBJECT The file upload associated with the dispute evidence. * dispute​Evidence​Type [Shopify​Payments​Dispute​Evidence​File​Type](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsDisputeEvidenceFileType) The type of the file for the dispute evidence. * file​Size [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The file size. * file​Type [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The file type. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * original​File​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The original file name. * url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The URL for accessing the file. * [Shopify​Payments​Dispute​Fulfillment](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDisputeFulfillment) OBJECT The fulfillment associated with dispute evidence. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * shipping​Carrier [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The shipping carrier for this fulfillment. * shipping​Date [Date](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Date) The shipping date for this fulfillment. * shipping​Tracking​Number [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The shipping tracking number for this fulfillment. * [Shopify​Payments​Payout](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout) OBJECT Payouts represent the movement of money between a merchant's Shopify Payments balance and their bank account. * business​Entity [Business​Entity!](https://shopify.dev/docs/api/admin-graphql/latest/objects/BusinessEntity) non-null The business entity associated with the payout. * external​Trace​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A unique trace ID from the financial institution. Use this reference number to track the payout with your provider. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * issued​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The exact time when the payout was issued. The payout only contains balance transactions that were available at this time. * 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. * net [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The total amount and currency of the payout. * status [Shopify​Payments​Payout​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsPayoutStatus) non-null The transfer status of the payout. * summary [Shopify​Payments​Payout​Summary!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayoutSummary) non-null The summary of the payout. * transaction​Type [Shopify​Payments​Payout​Transaction​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopifyPaymentsPayoutTransactionType) non-null The direction of the payout. * bank​Account [Shopify​Payments​Bank​Account](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBankAccount) Deprecated * gross [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-nullDeprecated * [Shop​Policy](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopPolicy) OBJECT Policy that a merchant has configured for their store, such as their refund or privacy policy. * body [HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML) non-null The text of the policy. The maximum size is 512kb. * created​At [Date!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Date) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the policy was created. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The translated title of the policy. For example, Refund Policy or Politique de remboursement. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) non-null The published translations associated with the resource. * type [Shop​Policy​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ShopPolicyType) non-null The shop policy type. * updated​At [Date!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Date) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the policy was last modified. * url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-null The public URL of the policy. * [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) OBJECT Represents the data about a staff member's Shopify account. Merchants can use staff member data to get more information about the staff members in their store. * account​Type [Account​Type](https://shopify.dev/docs/api/admin-graphql/latest/enums/AccountType) The type of account the staff member has. * active [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the staff member is active. * avatar [Image!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image) non-null The image used as the staff member's avatar in the Shopify admin. * email [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The staff member's email address. * exists [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the staff member's account exists. * first​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The staff member's first name. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * initials [\[String!\]](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The staff member's initials, if available. * is​Shop​Owner [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the staff member is the shop owner. * last​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The staff member's last name. * locale [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The staff member's preferred locale. Locale values use the format `language` or `language-COUNTRY`, where `language` is a two-letter language code, and `COUNTRY` is a two-letter country code. For example: `en` or `en-US` * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The staff member's full name. * phone [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The staff member's phone number. * private​Data [Staff​Member​Private​Data!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMemberPrivateData) non-null The data used to customize the Shopify admin experience for the staff member. * [Standard​Metafield​Definition​Template](https://shopify.dev/docs/api/admin-graphql/latest/objects/StandardMetafieldDefinitionTemplate) OBJECT Standard metafield definition templates provide preset configurations to create metafield definitions. Each template has a specific namespace and key that we've reserved to have specific meanings for common use cases. Refer to the [list of standard metafield definitions](https://shopify.dev/apps/metafields/definitions/standard-definitions). * description [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The description of the standard metafield definition. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * key [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The key owned by the definition after the definition has been activated. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The human-readable name for the standard metafield definition. * namespace [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The namespace owned by the definition after the definition has been activated. * owner​Types [\[Metafield​Owner​Type!\]!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldOwnerType) non-null The list of resource types that the standard metafield definition can be applied to. * type [Metafield​Definition​Type!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinitionType) non-null The associated [metafield definition type](https://shopify.dev/apps/metafields/definitions/types) that the metafield stores. * validations [\[Metafield​Definition​Validation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinitionValidation) non-null The configured validations for the standard metafield definition. * visible​To​Storefront​Api [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether metafields for the definition are by default visible using the Storefront API. * [Store​Credit​Account](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccount) OBJECT A store credit account contains a monetary balance that can be redeemed at checkout for purchases in the shop. The account is held in the specified currency and has an owner that cannot be transferred. The account balance is redeemable at checkout only when the owner is authenticated via [new customer accounts authentication](https://shopify.dev/docs/api/customer). * balance [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The current balance of the store credit account. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * owner [Has​Store​Credit​Accounts!](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasStoreCreditAccounts) non-null The owner of the store credit account. * transactions [Store​Credit​Account​Transaction​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/StoreCreditAccountTransactionConnection) non-null The transaction history of the store credit account. * [Store​Credit​Account​Credit​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccountCreditTransaction) OBJECT A credit transaction which increases the store credit account balance. * account [Store​Credit​Account!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccount) non-null The store credit account that the transaction belongs to. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount of the transaction. * balance​After​Transaction [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The balance of the account after the transaction. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the transaction was created. * event [Store​Credit​System​Event!](https://shopify.dev/docs/api/admin-graphql/latest/enums/StoreCreditSystemEvent) non-null The event that caused the store credit account transaction. * expires​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The time at which the transaction expires. Debit transactions will always spend the soonest expiring credit first. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * origin [Store​Credit​Account​Transaction​Origin](https://shopify.dev/docs/api/admin-graphql/latest/unions/StoreCreditAccountTransactionOrigin) The origin of the store credit account transaction. * remaining​Amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The remaining amount of the credit. The remaining amount will decrease when a debit spends this credit. It may also increase if that debit is subsequently reverted. In the event that the credit expires, the remaining amount will represent the amount that remained as the expiry ocurred. * [Store​Credit​Account​Debit​Revert​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccountDebitRevertTransaction) OBJECT A debit revert transaction which increases the store credit account balance. Debit revert transactions are created automatically when a [store credit account debit transaction](https://shopify.dev/api/admin-graphql/latest/objects/StoreCreditAccountDebitTransaction) is reverted. Store credit account debit transactions are reverted when an order is cancelled, refunded or in the event of a payment failure at checkout. The amount added to the balance is equal to the amount reverted on the original credit. * account [Store​Credit​Account!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccount) non-null The store credit account that the transaction belongs to. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount of the transaction. * balance​After​Transaction [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The balance of the account after the transaction. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the transaction was created. * debit​Transaction [Store​Credit​Account​Debit​Transaction!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccountDebitTransaction) non-null The reverted debit transaction. * event [Store​Credit​System​Event!](https://shopify.dev/docs/api/admin-graphql/latest/enums/StoreCreditSystemEvent) non-null The event that caused the store credit account transaction. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * origin [Store​Credit​Account​Transaction​Origin](https://shopify.dev/docs/api/admin-graphql/latest/unions/StoreCreditAccountTransactionOrigin) The origin of the store credit account transaction. * [Store​Credit​Account​Debit​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccountDebitTransaction) OBJECT A debit transaction which decreases the store credit account balance. * account [Store​Credit​Account!](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccount) non-null The store credit account that the transaction belongs to. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount of the transaction. * balance​After​Transaction [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The balance of the account after the transaction. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the transaction was created. * event [Store​Credit​System​Event!](https://shopify.dev/docs/api/admin-graphql/latest/enums/StoreCreditSystemEvent) non-null The event that caused the store credit account transaction. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * origin [Store​Credit​Account​Transaction​Origin](https://shopify.dev/docs/api/admin-graphql/latest/unions/StoreCreditAccountTransactionOrigin) The origin of the store credit account transaction. * [Storefront​Access​Token](https://shopify.dev/docs/api/admin-graphql/latest/objects/StorefrontAccessToken) OBJECT A token that's used to delegate unauthenticated access scopes to clients that need to access the unauthenticated [Storefront API](https://shopify.dev/docs/api/storefront). An app can have a maximum of 100 active storefront access tokens for each shop. [Get started with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/getting-started). * access​Scopes [\[Access​Scope!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) non-null List of permissions associated with the token. * access​Token [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The issued public access token. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the public access token was created. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null An arbitrary title for each token determined by the developer, used for reference purposes. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the storefront access token was updated. * [Subscription​Billing​Attempt](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingAttempt) OBJECT A record of an execution of the subscription billing process. Billing attempts use idempotency keys to avoid duplicate order creation. A successful billing attempt will create an order. * completed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the billing attempt was completed. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the billing attempt was created. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * idempotency​Key [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null A unique key generated by the client to avoid duplicate payments. * next​Action​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The result of this billing attempt if completed successfully. * origin​Time [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time used to calculate fulfillment intervals for a billing attempt that successfully completed after the current anchor date. To prevent fulfillment from being pushed to the next anchor date, this field can override the billing attempt date. * payment​Group​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The reference shared between retried payment attempts. * payment​Session​Id [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The reference shared between payment attempts with similar payment details. * processing​Error [Subscription​Billing​Attempt​Processing​Error](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/SubscriptionBillingAttemptProcessingError) Error information from processing the billing attempt. * ready [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the billing attempt is still processing. * respect​Inventory​Policy [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the billing attempt respects the merchant's inventory policy. * subscription​Contract [Subscription​Contract!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract) non-null The subscription contract. * transactions [Order​Transaction​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderTransactionConnection) non-null The transactions created by the billing attempt. * error​Code [Subscription​Billing​Attempt​Error​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/SubscriptionBillingAttemptErrorCode) Deprecated * error​Message [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Deprecated * [Subscription​Contract](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract) OBJECT Represents a Subscription Contract. * app [App](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) The subscription app that the subscription contract is registered to. * app​Admin​Url [URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) The URL of the subscription contract page on the subscription app. * billing​Attempts [Subscription​Billing​Attempt​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionBillingAttemptConnection) non-null The list of billing attempts associated with the subscription contract. * billing​Policy [Subscription​Billing​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingPolicy) non-null The billing policy associated with the subscription contract. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the subscription contract was created. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The currency that's used for the subscription contract. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of the custom attributes to be added to the generated orders. * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer to whom the subscription contract belongs. * customer​Payment​Method [Customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod) The customer payment method that's used for the subscription contract. * delivery​Method [Subscription​Delivery​Method](https://shopify.dev/docs/api/admin-graphql/latest/unions/SubscriptionDeliveryMethod) The delivery method for each billing of the subscription contract. * delivery​Policy [Subscription​Delivery​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionDeliveryPolicy) non-null The delivery policy associated with the subscription contract. * delivery​Price [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The delivery price for each billing of the subscription contract. * discounts [Subscription​Manual​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionManualDiscountConnection) non-null The list of subscription discounts associated with the subscription contract. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * last​Billing​Attempt​Error​Type [Subscription​Contract​Last​Billing​Error​Type](https://shopify.dev/docs/api/admin-graphql/latest/enums/SubscriptionContractLastBillingErrorType) The last billing error type of the contract. * last​Payment​Status [Subscription​Contract​Last​Payment​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/SubscriptionContractLastPaymentStatus) The current status of the last payment. * lines [Subscription​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionLineConnection) non-null The list of subscription lines associated with the subscription contract. * lines​Count [Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count) The number of lines associated with the subscription contract. * next​Billing​Date [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The next billing date for the subscription contract. This field is managed by the apps. Alternatively you can utilize our [Billing Cycles APIs](https://shopify.dev/docs/apps/selling-strategies/subscriptions/billing-cycles), which provide auto-computed billing dates and additional functionalities. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note field that will be applied to the generated orders. * orders [Order​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/OrderConnection) non-null A list of the subscription contract's orders. * origin​Order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The order from which this contract originated. * revision​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64) non-null The revision id of the contract. * status [Subscription​Contract​Subscription​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/SubscriptionContractSubscriptionStatus) non-null The current status of the subscription contract. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the subscription contract was updated. * line​Count [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-nullDeprecated * [Subscription​Draft](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionDraft) OBJECT The `SubscriptionDraft` object represents a draft version of a [subscription contract](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract) before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes. Use the `SubscriptionDraft` object to: * Add, remove, or modify subscription lines and their quantities * Manage discounts (add, remove, or update manual and code-based discounts) * Configure delivery options and shipping methods * Set up billing and delivery policies * Manage customer payment methods * Add custom attributes and notes to generated orders * Configure billing cycles and next billing dates * Preview the projected state of the subscription Each `SubscriptionDraft` object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription. The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible. Learn more about [how subscription contracts work](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts) and how to [build](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/build-a-subscription-contract), [update](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/update-a-subscription-contract), and [combine](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/combine-subscription-contracts) subscription contracts. * billing​Cycle [Subscription​Billing​Cycle](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingCycle) The billing cycle that the subscription contract will be associated with. * billing​Policy [Subscription​Billing​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingPolicy) non-null The billing policy for the subscription contract. * concatenated​Billing​Cycles [Subscription​Billing​Cycle​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionBillingCycleConnection) non-null The billing cycles of the contracts that will be concatenated to the subscription contract. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CurrencyCode) non-null The currency used for the subscription contract. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null A list of the custom attributes to be added to the generated orders. * customer [Customer!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) non-null The customer to whom the subscription contract belongs. * customer​Payment​Method [Customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod) The customer payment method used for the subscription contract. * delivery​Method [Subscription​Delivery​Method](https://shopify.dev/docs/api/admin-graphql/latest/unions/SubscriptionDeliveryMethod) The delivery method for each billing of the subscription contract. * delivery​Options [Subscription​Delivery​Option​Result](https://shopify.dev/docs/api/admin-graphql/latest/unions/SubscriptionDeliveryOptionResult) The available delivery options for a given delivery address. Returns `null` for pending requests. * delivery​Policy [Subscription​Delivery​Policy!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionDeliveryPolicy) non-null The delivery policy for the subscription contract. * delivery​Price [Money​V2](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) The delivery price for each billing the subscription contract. * discounts [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionDiscountConnection) non-null The list of subscription discounts which will be associated with the subscription contract. * discounts​Added [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionDiscountConnection) non-null The list of subscription discounts to be added to the subscription contract. * discounts​Removed [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionDiscountConnection) non-null The list of subscription discounts to be removed from the subscription contract. * discounts​Updated [Subscription​Discount​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionDiscountConnection) non-null The list of subscription discounts to be updated on the subscription contract. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * lines [Subscription​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionLineConnection) non-null The list of subscription lines which will be associated with the subscription contract. * lines​Added [Subscription​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionLineConnection) non-null The list of subscription lines to be added to the subscription contract. * lines​Removed [Subscription​Line​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionLineConnection) non-null The list of subscription lines to be removed from the subscription contract. * next​Billing​Date [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The next billing date for the subscription contract. * note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The note field that will be applied to the generated orders. * original​Contract [Subscription​Contract](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract) The original subscription contract. * status [Subscription​Contract​Subscription​Status](https://shopify.dev/docs/api/admin-graphql/latest/enums/SubscriptionContractSubscriptionStatus) The current status of the subscription contract. * shipping​Options [Subscription​Shipping​Option​Result](https://shopify.dev/docs/api/admin-graphql/latest/unions/SubscriptionShippingOptionResult) Deprecated * [Taxonomy​Attribute](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyAttribute) OBJECT A Shopify product taxonomy attribute. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * [Taxonomy​Category](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyCategory) OBJECT The details of a specific product category within the [Shopify product taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17). * ancestor​Ids [\[ID!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The IDs of the category's ancestor categories. * attributes [Taxonomy​Category​Attribute​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/TaxonomyCategoryAttributeConnection) non-null The attributes of the taxonomy category. * children​Ids [\[ID!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The IDs of the category's child categories. * full​Name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The full name of the taxonomy category. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The globally-unique ID of the TaxonomyCategory. * is​Archived [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the category is archived. The default value is `false`. * is​Leaf [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the category is a leaf category. A leaf category doesn't have any subcategories beneath it. For example, in Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Treadmills, Dog Treadmills is a leaf category. The value is `true` when there are no `childrenIds` specified. * is​Root [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the category is a root category. A root category is at the top level of the category hierarchy and doesn't have a parent category. For example, Animals & Pet Supplies. The value is `true` when there's no `parentId` specified. * level [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The level of the category in the taxonomy tree. Levels indicate the depth of the category from the root. For example, in Animals & Pet Supplies > Pet Supplies > Dog Supplies, Animals & Pet Supplies is at level 1, Animals & Pet Supplies > Pet Supplies is at level 2, and Animals & Pet Supplies > Pet Supplies > Dog Supplies is at level 3. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the taxonomy category. For example, Dog Beds. * parent​Id [ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) The ID of the category's parent category. * [Taxonomy​Choice​List​Attribute](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyChoiceListAttribute) OBJECT A Shopify product taxonomy choice list attribute. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID of the TaxonomyAttribute. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the product taxonomy attribute. For example, Color. * values [Taxonomy​Value​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/TaxonomyValueConnection) non-null A list of values on the choice list attribute. * [Taxonomy​Measurement​Attribute](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyMeasurementAttribute) OBJECT A Shopify product taxonomy measurement attribute. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The unique ID of the TaxonomyAttribute. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the product taxonomy attribute. For example, Color. * options [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Attribute) non-null The product taxonomy attribute options. * [Taxonomy​Value](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyValue) OBJECT Represents a Shopify product taxonomy value. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the product taxonomy value. For example, Red. * [Tender​Transaction](https://shopify.dev/docs/api/admin-graphql/latest/objects/TenderTransaction) OBJECT A TenderTransaction represents a transaction with financial impact on a shop's balance sheet. A tender transaction always represents actual money movement between a buyer and a shop. TenderTransactions can be used instead of OrderTransactions for reconciling a shop's cash flow. A TenderTransaction is immutable once created. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The amount and currency of the tender transaction. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * order [Order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) The order that's related to the tender transaction. This value is null if the order has been deleted. * payment​Method [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Information about the payment method used for the transaction. * processed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) Date and time when the transaction was processed. * remote​Reference [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The remote gateway reference associated with the tender transaction. * test [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the transaction is a test transaction. * transaction​Details [Tender​Transaction​Details](https://shopify.dev/docs/api/admin-graphql/latest/unions/TenderTransactionDetails) Information about the payment instrument used for the transaction. * user [Staff​Member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) The staff member who performed the transaction. * [Transaction​Fee](https://shopify.dev/docs/api/admin-graphql/latest/objects/TransactionFee) OBJECT Transaction fee related to an order transaction. * amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null Amount of the fee. * flat​Fee [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null Flat rate charge for a transaction. * flat​Fee​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Name of the credit card flat fee. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * rate [Decimal!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Decimal) non-null Percentage charge. * rate​Name [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) Name of the credit card rate. * tax​Amount [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null Tax amount charged on the fee. * type [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Name of the type of fee. * [Unverified​Return​Line​Item](https://shopify.dev/docs/api/admin-graphql/latest/objects/UnverifiedReturnLineItem) OBJECT An unverified return line item. * customer​Note [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A note from the customer that describes the item to be returned. Maximum length: 300 characters. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * processable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that can be processed. * processed​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that has been processed. * quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity being returned. * refundable​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that can be refunded. * refunded​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that was refunded. * return​Reason [Return​Reason!](https://shopify.dev/docs/api/admin-graphql/latest/enums/ReturnReason) non-null The reason for returning the item. * return​Reason​Note [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null Additional information about the reason for the return. Maximum length: 255 characters. * unit​Price [Money​V2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2) non-null The unit price of the unverified return line item. * unprocessed​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The quantity that has't been processed. * [Url​Redirect](https://shopify.dev/docs/api/admin-graphql/latest/objects/UrlRedirect) OBJECT The URL redirect for the online store. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of the URL redirect. * path [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The old path to be redirected from. When the user visits this path, they will be redirected to the target location. * target [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The target location where the user will be redirected to. * [Url​Redirect​Import](https://shopify.dev/docs/api/admin-graphql/latest/objects/UrlRedirectImport) OBJECT A request to import a [`URLRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object into the Online Store channel. Apps can use this to query the state of an `UrlRedirectImport` request. For more information, see [`url-redirect`](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect)s. * count [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The number of rows in the file. * created​Count [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The number of redirects created from the import. * failed​Count [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The number of redirects that failed to be imported. * finished [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the import is finished. * finished​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time when the import finished. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of the `UrlRedirectImport` object. * preview​Redirects [\[Url​Redirect​Import​Preview!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/UrlRedirectImportPreview) non-null A list of up to three previews of the URL redirects to be imported. * updated​Count [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The number of redirects updated during the import. * [Validation](https://shopify.dev/docs/api/admin-graphql/latest/objects/Validation) OBJECT A checkout server side validation installed on the shop. * block​On​Failure [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the validation should block on failures other than expected violations. * enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) non-null Whether the validation is enabled on the merchant checkout. * 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 validation function. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null Global ID for the validation. * 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 validation. * title [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The merchant-facing validation name. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Video](https://shopify.dev/docs/api/admin-graphql/latest/objects/Video) OBJECT Represents a Shopify hosted video. * alt [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A word or phrase to share the nature or contents of a media. * 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)) when the file was created. * duration [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The video's duration in milliseconds. This value is `null` unless the video's status field is [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready). * file​Errors [\[File​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/FileError) non-null Any errors that have occurred on the file. * filename [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The video's filename. * file​Status [File​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/FileStatus) non-null The status of the file. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaContentType) non-null The media content type. * media​Errors [\[Media​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaError) non-null Any errors which have occurred on the media. * media​Warnings [\[Media​Warning!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaWarning) non-null The warnings attached to the media. * original​Source [Video​Source](https://shopify.dev/docs/api/admin-graphql/latest/objects/VideoSource) The video's original source. This value is `null` unless the video's status field is [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready). * preview [Media​Preview​Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/MediaPreviewImage) The preview image for the media. * sources [\[Video​Source!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/VideoSource) non-null The video's sources. This value is empty unless the video's status field is [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready). * status [Media​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaStatus) non-null Current status of the media. * 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 file was last updated. * [Webhook​Subscription](https://shopify.dev/docs/api/admin-graphql/latest/objects/WebhookSubscription) OBJECT A webhook subscription is a persisted data object created by an app using the REST Admin API or GraphQL Admin API. It describes the topic that the app wants to receive, and a destination where Shopify should send webhooks of the specified topic. When an event for a given topic occurs, the webhook subscription sends a relevant payload to the destination. Learn more about the [webhooks system](https://shopify.dev/apps/webhooks). * api​Version [Api​Version!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ApiVersion) non-null The Admin API version that Shopify uses to serialize webhook events. This value is inherited from the app that created the webhook subscription. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the webhook subscription was created. * filter [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A constraint specified using search syntax that ensures only webhooks that match the specified filter are emitted. See our [guide on filters](https://shopify.dev/docs/apps/build/webhooks/customize/filters) for more details. * format [Webhook​Subscription​Format!](https://shopify.dev/docs/api/admin-graphql/latest/enums/WebhookSubscriptionFormat) non-null The format in which the webhook subscription should send the data. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * include​Fields [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The list of fields to be included in the webhook subscription. Only the fields specified will be included in the webhook payload. If null, then all fields will be included. Learn more about [modifying webhook payloads](https://shopify.dev/docs/apps/build/webhooks/customize/modify_payloads). * 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​Namespaces [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The list of namespaces for any metafields that should be included in the webhook subscription. * metafields [\[Webhook​Subscription​Metafield​Identifier!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/WebhookSubscriptionMetafieldIdentifier) non-null The list of identifiers specifying metafields to include in the webhook subscription. * topic [Webhook​Subscription​Topic!](https://shopify.dev/docs/api/admin-graphql/latest/enums/WebhookSubscriptionTopic) non-null The type of event that triggers the webhook. The topic determines when the webhook subscription sends a webhook, as well as what class of data object that webhook contains. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time when the webhook subscription was updated. * uri [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The URI to which the webhook subscription will send events. * callback​Url [URL!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL) non-nullDeprecated * endpoint [Webhook​Subscription​Endpoint!](https://shopify.dev/docs/api/admin-graphql/latest/unions/WebhookSubscriptionEndpoint) non-nullDeprecated * [Web​Pixel](https://shopify.dev/docs/api/admin-graphql/latest/objects/WebPixel) OBJECT The `WebPixel` object enables you to manage JavaScript code snippets that run on an online store and collect [behavioral data](https://shopify.dev/docs/api/web-pixels-api/standard-events) for marketing campaign optimization and analytics. Learn how to create a [web pixel extension](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels) to subscribe your app to events that are emitted by Shopify. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null A globally-unique ID. * settings [JSON!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/JSON) non-null The [settings object](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels#step-2-define-your-web-pixel-settings) for the web pixel. This object specifies configuration options that control the web pixel's functionality and behavior. You can find the settings for a web pixel in `extensions//shopify.extension.toml`. *** ```json { "id": "" } ``` ##### Variables ``` { "id": "" } ``` ##### Schema ``` interface Node { id: ID! } ```