--- title: LegacyInteroperability - GraphQL Admin description: >- Interoperability metadata for types that directly correspond to a REST Admin API resource. For example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://shopify.dev/api/admin-graphql/latest/objects/product) in the REST Admin API. api_version: 2025-01 api_name: admin type: interface api_type: graphql source_url: html: >- https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/LegacyInteroperability md: >- https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/LegacyInteroperability.md --- # Legacy​Interoperability interface Interoperability metadata for types that directly correspond to a REST Admin API resource. For example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://shopify.dev/api/admin-graphql/latest/objects/product) in the REST Admin API. ## Fields * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. *** ## Types implemented in * [Customer](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/MailingAddress) non-null A list of addresses associated with the customer. * addresses​V2 [Mailing​Address​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MailingAddressConnection) non-null The addresses associated with the customer. * amount​Spent [Money​V2!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/CompanyContact) non-null A list of the customer's company contact profiles. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/MailingAddress) The default address associated with the customer. * display​Name [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/EventConnection) non-null A list of events associated with the customer. * first​Name [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The customer's first name. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * image [Image!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Image) non-null The image associated with the customer. * last​Name [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The customer's last name. * last​Order [Order](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Order) The customer's last order. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/String) non-null The customer's locale. * market [Market](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Market) The market that includes the customer’s default address. * mergeable [Customer​Mergeable!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/CustomerMergeable) non-null Whether the customer can be merged with another customer. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/String) A unique identifier for the customer that's used with Multipass login. * note [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) A note about the customer. * number​Of​Orders [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/OrderConnection) non-null A list of the customer's orders. * payment​Methods [Customer​Payment​Method​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/objects/CustomerStatistics) non-null The statistics for a given customer. * store​Credit​Accounts [Store​Credit​Account​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/SubscriptionContractConnection) non-null A list of the customer's subscription contracts. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/enums/TaxExemption) non-null The list of tax exemptions applied to the customer. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) non-null The date and time when the customer was last updated. * verified​Email [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/String) Deprecated * email​Marketing​Consent [Customer​Email​Marketing​Consent​State](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/CustomerEmailMarketingConsentState) Deprecated * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MetafieldDefinitionConnection) non-nullDeprecated * phone [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Deprecated * sms​Marketing​Consent [Customer​Sms​Marketing​Consent​State](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/CustomerSmsMarketingConsentState) Deprecated * unsubscribe​Url [URL!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/URL) non-nullDeprecated * valid​Email​Address [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-nullDeprecated * [Draft​Order](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/Boolean) non-null Whether all variant prices have been overridden. * any​Variant​Prices​Overridden [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether any variant prices have been overridden. * applied​Discount [Draft​Order​Applied​Discount](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/DraftOrderAppliedDiscount) The custom order-level discount applied. * billing​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MailingAddress) The billing address of the customer. * billing​Address​Matches​Shipping​Address [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether the billing address matches the shipping address. * completed​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/enums/CurrencyCode) non-null The shop currency used for calculation. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/Customer) The customer who will be sent an invoice. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/String) non-null All discount codes applied. * email [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The email address of the customer, which is used to send notifications. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/EventConnection) non-null The list of events associated with the draft order. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether the merchant has added timeline comments to the draft order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * invoice​Email​Template​Subject [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/connections/LocalizedFieldConnection) non-null List of localized fields for the resource. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/String) The text from an optional note attached to the draft order. * order [Order](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Order) The order that was created from the draft order. * payment​Terms [Payment​Terms](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/PaymentTerms) The associated payment terms for this draft order. * phone [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The assigned phone number. * platform​Discounts [\[Draft​Order​Platform​Discount!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/DraftOrderPlatformDiscount) non-null The list of platform discounts applied. * po​Number [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The purchase order number. * presentment​Currency​Code [Currency​Code!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/CurrencyCode) non-null The payment currency used for calculation. * purchasing​Entity [Purchasing​Entity](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/PurchasingEntity) The purchasing entity. * ready [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/DateTime) The time after which inventory will automatically be restocked. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MailingAddress) The shipping address of the customer. * shipping​Line [Shipping​Line](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/ShippingLine) The line item containing the shipping information and costs. * status [Draft​Order​Status!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/DraftOrderStatus) non-null The status of the draft order. * subtotal​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/Boolean) non-null Whether the line item prices include taxes. * tax​Exempt [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether the draft order is tax exempt. * tax​Lines [\[Tax​Line!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/MoneyBag) non-null Total discounts. * total​Line​Items​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MoneyBag) non-null Total price of line items, excluding discounts. * total​Price​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/MoneyBag) non-null The total shipping price. * total​Tax​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MoneyBag) non-null The total tax. * total​Weight [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/UnsignedInt64) non-null The total weight in grams of the draft order. * transformer​Fingerprint [String](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/interfaces/DraftOrderWarning) non-null The list of warnings raised while calculating. * localization​Extensions [Localization​Extension​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/LocalizationExtensionConnection) non-nullDeprecated * market​Name [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-nullDeprecated * market​Region​Country​Code [Country​Code!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/CountryCode) non-nullDeprecated * subtotal​Price [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Price [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Shipping​Price [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Tax [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * [Fulfillment](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the fulfillment was created. * delivered​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) The date that this fulfillment was delivered. * display​Status [Fulfillment​Display​Status](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/FulfillmentDisplayStatus) Human readable display status for this fulfillment. * estimated​Delivery​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) The estimated date that this fulfillment will arrive. * events [Fulfillment​Event​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/FulfillmentLineItemConnection) non-null List of the fulfillment's line items. * fulfillment​Orders [Fulfillment​Order​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/FulfillmentOrderConnection) non-null A paginated list of fulfillment orders for the fulfillment. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * in​Transit​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) The date and time when the fulfillment went into transit. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * location [Location](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Location) The location that the fulfillment was processed at. * name [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-null Human readable reference identifier for this fulfillment. * order [Order!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Order) non-null The order for which the fulfillment was created. * origin​Address [Fulfillment​Origin​Address](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/FulfillmentService) Fulfillment service associated with the fulfillment. * status [Fulfillment​Status!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/FulfillmentStatus) non-null The status of the fulfillment. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the fulfillment was last modified. * [Inventory​Item](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/connections/CountryHarmonizedSystemCodeConnection) non-null A list of country specific harmonized system codes. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/ID) non-null A globally-unique ID. * inventory​History​Url [URL](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/URL) The URL that points to the inventory history for the item. * inventory​Level [Inventory​Level](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/InventoryLevel) The inventory item's quantities at the specified location. * inventory​Levels [Inventory​Level​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/Count) The number of locations where this inventory item is stocked. * measurement [Inventory​Item​Measurement!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/InventoryItemMeasurement) non-null The packaging dimensions of the inventory item. * province​Code​Of​Origin [String](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/Boolean) non-null Whether the inventory item requires shipping. * sku [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Inventory item SKU. Case-sensitive string. * tracked [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether inventory levels are tracked for the item. * tracked​Editable [Editable​Property!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the inventory item was updated. * variant [Product​Variant!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/ProductVariant) non-null The variant that owns this inventory item. * [Location](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/LocationAddress) non-null The address of this location. * address​Verified [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether the location address has been verified. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/Boolean) non-null Whether this location can be deleted. * fulfillment​Service [Fulfillment​Service](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/FulfillmentService) Name of the service provider that fulfills from this location. * fulfills​Online​Orders [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether this location can fulfill online orders. * has​Active​Inventory [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether this location has active inventory. * has​Unfulfilled​Orders [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether this location has orders that need to be fulfilled. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * inventory​Level [Inventory​Level](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/InventoryLevel) The quantities of an inventory item at this location. * inventory​Levels [Inventory​Level​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/Boolean) non-null Whether this location is a fulfillment service. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/DeliveryLocalPickupSettings) Local pickup settings for the location. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/String) non-null The name of the location. * ships​Inventory [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/Boolean) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MetafieldDefinitionConnection) non-nullDeprecated * [Marketing​Event](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MarketingEvent) OBJECT Represents actions that market a merchant's store or products. * app [App!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/App) non-null The app that the marketing event is attributed to. * channel​Handle [String](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/String) A human-readable description of the marketing event. * ended​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) The date and time when the marketing event ended. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/URL) The URL where the marketing event can be managed. * marketing​Channel​Type [Marketing​Channel](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/URL) The URL where the marketing event can be previewed. * remote​Id [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) An optional ID that helps Shopify validate engagement data. * scheduled​To​End​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the marketing event started. * type [Marketing​Tactic!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/MarketingTactic) non-null The marketing event type. * utm​Campaign [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The name of the marketing campaign. * utm​Medium [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The medium that the marketing campaign is using. Example values: `cpc`, `banner`. * utm​Source [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The referrer of the marketing event. Example values: `google`, `newsletter`. * channel [Marketing​Channel](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/MarketingChannel) Deprecated * target​Type​Display​Text [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-nullDeprecated * [Metafield](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the metafield was created. * definition [Metafield​Definition](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MetafieldDefinition) The metafield definition that the metafield belongs to, if any. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * json​Value [JSON!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/JSON) non-null The data stored in the metafield in JSON format. * key [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * namespace [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/interfaces/HasMetafields) non-null The resource that the metafield is attached to. * owner​Type [Metafield​Owner​Type!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/MetafieldOwnerType) non-null The type of resource that the metafield is attached to. * reference [Metafield​Reference](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the metafield was updated. * value [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/String) Deprecated * [Order](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/objects/Count) The total number of fulfillments for the order, including canceled ones. * fully​Paid [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/Boolean) non-null Whether the merchant has added a timeline comment to the order. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/connections/LocalizedFieldConnection) non-null List of localized fields for the resource. * merchant​Business​Entity [Business​Entity!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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. * original​Total​Additional​Fees​Set [Money​Bag](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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. * publication [Publication](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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. * subtotal​Line​Items​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/UnsignedInt64) The total weight of the order before returns, in grams. * transactions [\[Order​Transaction!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/OrderTransaction) non-null A list of transactions associated with the order. * transactions​Count [Count](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Count) The number of transactions associated with the order. * unpaid [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Whether no payments have been made for the order. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/Money) Deprecated * channel [Channel](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Channel) Deprecated * customer​Journey [Customer​Journey](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/CustomerJourney) Deprecated * landing​Page​Display​Text [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Deprecated * landing​Page​Url [URL](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/URL) Deprecated * localization​Extensions [Localization​Extension​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/LocalizationExtensionConnection) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MetafieldDefinitionConnection) non-nullDeprecated * net​Payment [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * physical​Location [Location](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Location) Deprecated * referral​Code [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Deprecated * referrer​Display​Text [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Deprecated * referrer​Url [URL](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/URL) Deprecated * risk​Level [Order​Risk​Level!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/OrderRiskLevel) non-nullDeprecated * risks [\[Order​Risk!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/OrderRisk) non-nullDeprecated * subtotal​Price [Money](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) Deprecated * total​Capturable [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Discounts [Money](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) Deprecated * total​Price [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Received [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Refunded [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Shipping​Price [Money!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) non-nullDeprecated * total​Tax [Money](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Money) Deprecated * total​Tip​Received [Money​V2!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MoneyV2) non-nullDeprecated * [Price​Rule](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/objects/App) The application that created the price rule. * combines​With [Discount​Combines​With!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/PriceRuleCustomerSelection) non-null The customers that can use this price rule. * discount​Class [Discount​Class!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/DiscountClass) non-null The [discount class](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that's used to control how discounts can be combined. * discount​Codes [Price​Rule​Discount​Code​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/PriceRuleDiscountCodeConnection) non-null List of the price rule's discount codes. * discount​Codes​Count [Count](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Count) How many discount codes associated with the price rule. * ends​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/enums/PriceRuleFeature) non-null A list of the price rule's features. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null Indicates whether there are any timeline comments on the price rule. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * item​Entitlements [Price​Rule​Item​Entitlements!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/objects/PriceRuleShippingLineEntitlements) non-null The shipping lines to which the price rule applies. * starts​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) non-null The date and time when the price rule starts. * status [Price​Rule​Status!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/PriceRuleStatus) non-null The status of the price rule. * summary [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) A detailed summary of the price rule. * target [Price​Rule​Target!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/String) non-null The title of the price rule. * total​Sales [Money​V2](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MoneyV2) The total sales from orders where the price rule was used. * usage​Count [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/unions/PricingValue) non-null The value of the price rule. * entitlement​To​Prerequisite​Quantity​Ratio [Price​Rule​Entitlement​To​Prerequisite​Quantity​Ratio](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/PriceRuleEntitlementToPrerequisiteQuantityRatio) Deprecated * traits [\[Price​Rule​Trait!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/PriceRuleTrait) non-nullDeprecated * value [Price​Rule​Value!](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/PriceRuleValue) non-nullDeprecated * [Product](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the product was created. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/Int) ### Arguments Truncates a string after the given length. *** * description​Html [HTML!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/EventConnection) non-null The paginated list of events associated with the host subject. * featured​Media [Media](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/ID) non-null A globally-unique ID. * in​Collection [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/Boolean) non-null Whether the product is a gift card. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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​Type [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/input-objects/ContextualPublicationContext) required ### Arguments The context used to determine publication status. *** * published​On​Current​Publication [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/Int) non-null The quantity of inventory that's in stock. * tracks​Inventory [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/Translation) non-null The published translations associated with the resource. * unpublished​Publications [Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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 2000 variants. * variants​Count [Count](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/String) non-null The name of the product's vendor. * body​Html [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Deprecated * custom​Product​Type [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Deprecated * description​Plain​Summary [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-nullDeprecated * featured​Image [Image](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Image) Deprecated * images [Image​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/ImageConnection) non-nullDeprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MetafieldDefinitionConnection) non-nullDeprecated * price​Range [Product​Price​Range!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/ProductPriceRange) non-nullDeprecated * product​Category [Product​Category](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/ProductCategory) Deprecated * product​Publications [Product​Publication​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/ProductPublicationConnection) non-nullDeprecated * publication​Count [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) non-nullDeprecated * only​Published [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/ProductPublicationConnection) non-nullDeprecated * published​On​Channel [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-nullDeprecated * channel​Id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) required ### Arguments The ID of the channel to check. *** * published​On​Current​Channel [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-nullDeprecated * selling​Plan​Group​Count [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) non-nullDeprecated * standardized​Product​Type [Standardized​Product​Type](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/StandardizedProductType) Deprecated * storefront​Id [Storefront​ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/StorefrontID) non-nullDeprecated * total​Variants [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) non-nullDeprecated * unpublished​Channels [Channel​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/ChannelConnection) non-nullDeprecated * [Product​Variant](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/Boolean) non-null Whether the product variant is available for sale. * barcode [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The value of the barcode associated with the product. * compare​At​Price [Money](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the variant was created. * default​Cursor [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/connections/EventConnection) non-null The paginated list of events associated with the host subject. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * inventory​Item [Inventory​Item!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/Int) The total sellable quantity of the variant. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/MediaConnection) non-null The media associated with the product variant. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/Money) non-null The price of the product variant in the default shop currency. * product [Product!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Product) non-null The product that this variant belongs to. * product​Variant​Components [Product​Variant​Component​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/ProductVariantComponentConnection) non-null A list of the product variant components. * requires​Components [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/SelectedOption) non-null List of product options applied to the variant. * sellable​Online​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/Count) Count of selling plan groups associated with the product variant. * sku [String](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/Boolean) non-null Whether a tax is charged when the product variant is sold. * title [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-null The title of the product variant. * translations [\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Translation) non-null The published translations associated with the resource. * unit​Price​Measurement [Unit​Price​Measurement](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/UnitPriceMeasurement) The unit price measurement for the variant. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/Image) Deprecated * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MetafieldDefinitionConnection) non-nullDeprecated * presentment​Prices [Product​Variant​Price​Pair​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/ProductVariantPricePairConnection) non-nullDeprecated * selling​Plan​Group​Count [Int!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) non-nullDeprecated * storefront​Id [Storefront​ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/StorefrontID) non-nullDeprecated * tax​Code [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) Deprecated * [Refund](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/DateTime) The date and time when the refund was created. * duties [\[Refund​Duty!\]](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/RefundDuty) A list of the refunded duties as part of this refund. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * note [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The optional note associated with the refund. * order [Order!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Order) non-null The order associated with the refund. * order​Adjustments [Order​Adjustment​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/connections/RefundShippingLineConnection) non-null The `RefundShippingLine` resources attached to the refund. * return [Return](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Return) The return associated with the refund. * staff​Member [Staff​Member](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/StaffMember) The staff member who created the refund. * total​Refunded​Set [Money​Bag!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/connections/OrderTransactionConnection) non-null The transactions associated with the refund. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) non-null The date and time when the refund was updated. * total​Refunded [Money​V2!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MoneyV2) non-nullDeprecated * [Saved​Search](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/SearchFilter) non-null The filters of a saved search. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * name [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-null The name of a saved search. * query [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/enums/SearchResultType) non-null The type of resource this saved search is searching in. * search​Terms [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-null The search terms of a saved search. * [Script​Tag](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/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/2025-01/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/2025-01/scalars/ID) non-null A globally-unique ID. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * src [URL!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/URL) non-null The URL to the remote script. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) non-null The date and time when the script tag was last updated. * [Shopify​Payments​Dispute](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/MoneyV2) non-null The total amount disputed by the cardholder. * evidence​Due​By [Date](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Date) The deadline for evidence submission. * evidence​Sent​On [Date](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/ID) non-null A globally-unique ID. * initiated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) non-null The date when this dispute was initiated. * legacy​Resource​Id [Unsigned​Int64!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/UnsignedInt64) non-null The ID of the corresponding resource in the REST Admin API. * order [Order](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/ShopifyPaymentsDisputeReasonDetails) non-null The reason of the dispute. * status [Dispute​Status!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/DisputeStatus) non-null The current state of the dispute. * type [Dispute​Type!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/DisputeType) non-null Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. * [Shopify​Payments​Payout](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/objects/BusinessEntity) non-null The business entity associated with the payout. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * issued​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/objects/MoneyV2) non-null The total amount and currency of the payout. * status [Shopify​Payments​Payout​Status!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/ShopifyPaymentsPayoutStatus) non-null The transfer status of the payout. * summary [Shopify​Payments​Payout​Summary!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/ShopifyPaymentsPayoutSummary) non-null The summary of the payout. * transaction​Type [Shopify​Payments​Payout​Transaction​Type!](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/ShopifyPaymentsPayoutTransactionType) non-null The direction of the payout. * bank​Account [Shopify​Payments​Bank​Account](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/ShopifyPaymentsBankAccount) Deprecated * gross [Money​V2!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/MoneyV2) non-nullDeprecated * [Webhook​Subscription](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the webhook subscription was created. * filter [String](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/enums/WebhookSubscriptionFormat) non-null The format in which the webhook subscription should send the data. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * include​Fields [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/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/2025-01/scalars/String) non-null The list of namespaces for any metafields that should be included in the webhook subscription. * topic [Webhook​Subscription​Topic!](https://shopify.dev/docs/api/admin-graphql/2025-01/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/2025-01/scalars/DateTime) non-null The date and time when the webhook subscription was updated. * callback​Url [URL!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/URL) non-nullDeprecated * endpoint [Webhook​Subscription​Endpoint!](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/WebhookSubscriptionEndpoint) non-nullDeprecated *** ```json { "legacyResourceId": "" } ``` ##### Variables ``` { "legacyResourceId": "" } ``` ##### Schema ``` interface LegacyInteroperability { legacyResourceId: UnsignedInt64! } ```