MetafieldReference

The number of publications that a resource is published to, without feedback errors.

A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.

The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.

The paginated list of events associated with the host subject.

Information about the collection that's provided through resource feedback.

A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title Summer Catalog 2022 might have the handle summer-catalog-2022.

If the title is changed, the handle doesn't automatically change.

The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.

Whether the collection includes the specified product.

A globally-unique ID.

The image associated with the collection.

The ID of the corresponding resource in the REST Admin API.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The products that are included in the collection.

The number of products in the collection.

Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.

Whether the resource is published to a specified publication.

The list of resources that are published to a publication.

The number of publications that a resource is published to, without feedback errors.

The list of resources that are either published or staged to be published to a publication.

For a smart (automated) collection, specifies the rules that determine whether a product is included.

If the default SEO fields for page title and description have been modified, contains the modified information.

The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.

The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is custom, then the collection is using the collection.custom.liquid template. If the value is null, then the collection is using the default collection.liquid template.

The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.

The published translations associated with the resource.

The list of publications that the resource isn't published to.

The date and time (ISO 8601 format) when the collection was last modified.

The list of roles for the company contacts.

The list of contacts in the company.

The number of contacts that belong to the company.

The date and time (ISO 8601 format) at which the company was created in Shopify.

The date and time (ISO 8601 format) at which the company became the customer.

A default cursor that returns the single next record, sorted ascending by ID.

The role proposed by default for a contact at the company.

The list of the company's draft orders.

The paginated list of events associated with the host subject.

A unique externally-supplied ID for the company.

Whether the merchant added a timeline comment to the company.

A globally-unique ID.

The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.

The list of locations in the company.

The number of locations that belong to the company.

The main contact for the company.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The name of the company.

A note about the company.

The list of the company's orders.

The total number of orders placed for this company, across all its locations.

The total amount spent by this company, across all its locations.

The date and time (ISO 8601 format) at which the company was last modified.

A list of addresses associated with the customer.

The addresses associated with the customer.

The total amount that the customer has spent on orders in their lifetime.

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.

A list of the customer's company contact profiles.

The date and time when the customer was added to the store.

Whether the customer has opted out of having their data sold.

The default address associated with the customer.

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.

A list of events associated with the customer.

The customer's first name.

A globally-unique ID.

The image associated with the customer.

The customer's last name.

The customer's last order.

The ID of the corresponding resource in the REST Admin API.

The amount of time since the customer was first added to the store.

Example: 'about 12 years'.

The customer's locale.

The market that includes the customer’s default address.

Whether the customer can be merged with another customer.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

A unique identifier for the customer that's used with Multipass login.

A note about the customer.

The number of orders that the customer has made at the store in their lifetime.

A list of the customer's orders.

A list of the customer's payment methods.

Possible subscriber states of a customer defined by their subscription contracts.

The state of the customer's account with the shop.

Please note that this only meaningful when Classic Customer Accounts is active.

The statistics for a given customer.

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.

A list of the customer's subscription contracts.

A comma separated list of tags that have been added to the customer.

Whether the customer is exempt from being charged taxes on their orders.

The list of tax exemptions applied to the customer.

The date and time when the customer was last updated.

Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.

A word or phrase to describe the contents or the function of a file.

The date and time (ISO 8601 format) when the file was created.

Any errors that have occurred on the file.

The status of the file.

A globally-unique ID.

The generic file's MIME type.

The generic file's size in bytes.

The preview image for the media.

The date and time (ISO 8601 format) when the file was last updated.

The generic file's URL.

A word or phrase to share the nature or contents of a media.

The date and time (ISO 8601 format) when the file was created.

Any errors that have occurred on the file.

The status of the file.

A globally-unique ID.

The image for the media. Returns null until status is READY.

The media content type.

Any errors which have occurred on the media.

The warnings attached to the media.

The MIME type of the image.

The original source of the image.

The preview image for the media.

Current status of the media.

The date and time (ISO 8601 format) when the file was last updated.

Metaobject capabilities for this Metaobject.

The app used to create the object.

The app used to create the object.

The staff member who created the metaobject.

The MetaobjectDefinition that models this object type.

The preferred display name field value of the metaobject.

The field for an object key, or null if the key has no field definition.

All ordered fields of the metaobject with their definitions and values.

The unique handle of the object, useful as a custom ID.

A globally-unique ID.

List of back references metafields that belong to the resource.

The recommended field to visually represent this metaobject. May be a file reference or color field.

The type of the metaobject.

When the object was last updated.

A word or phrase to describe the contents or the function of a file.

The 3d model's bounding box information.

The date and time (ISO 8601 format) when the file was created.

Any errors that have occurred on the file.

The 3d model's filename.

The status of the file.

A globally-unique ID.

The media content type.

Any errors which have occurred on the media.

The warnings attached to the media.

The 3d model's original source.

The preview image for the media.

The 3d model's sources.

Current status of the media.

The date and time (ISO 8601 format) when the file was last updated.

A list of additional fees applied to an order, such as duties, import fees, or tax lines.

A list of sales agreements associated with the order, such as contracts defining payment terms, or delivery schedules between merchants and customers.

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.

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.

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.

Whether the billing address matches the shipping address. Returns true if both addresses are the same, and false if they're different or if an address is missing.

Details of an order's cancellation, if it has been canceled. This includes the reason, date, and any staff notes.

The date and time in ISO 8601 format when an order was canceled. Returns null if the order hasn't been canceled.

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.

Whether an order can be manually marked as paid. Returns false if the order is already paid, is canceled, has pending Shopify Payments transactions, or has a negative payment amount.

Whether order notifications can be sent to the customer. Returns true if the customer has a valid email address.

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.

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.

Details about the sales channel that created the order, such as the channel app type and channel name, which helps to track order sources.

The IP address of the customer who placed the order. Useful for fraud detection and geographic analysis.

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.

The date and time ISO 8601 format 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.

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.

Whether inventory has been reserved for an order. Returns true if inventory quantities for an order's line items have been reserved. Learn more about managing inventory quantities and states.

The date and time in ISO 8601 format when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle.

The shop currency when the order was placed. For example, "USD" or "CAD".

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 field.

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.

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.

The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts.

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.

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.

The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts.

The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations.

The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.

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.

The total weight of the order after returns and refunds, in grams.

A list of additional information that has been attached to the order. For example, gift message, delivery instructions, or internal notes.

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.

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.

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.

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.

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.

The discount code used for an order. Returns null if no discount code was applied.

The discount codes used for the order. Multiple codes can be applied to a single order.

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.

An order's financial status for display in the Shopify admin.

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 object.

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.

Whether duties are included in the subtotal price of the order. Duties are import taxes charged by customs authorities when goods cross international borders.

Whether the order has had any edits applied. For example, adding or removing line items, updating quantities, or changing prices.

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.

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.

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.

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 object.

A list of fulfillment orders for an order. Each fulfillment order groups line items that are fulfilled together, allowing an order to be processed in parts if needed.

A list of shipments for the order. Fulfillments represent the physical shipment of products to customers.

The total number of fulfillments for the order, including canceled ones.

Whether the order has been paid in full. This field returns true when the total amount received equals or exceeds the order total.

Whether the merchant has added a timeline comment to the order.

A globally-unique ID.

The ID of the corresponding resource in the REST Admin API.

A list of the order's line items. Line items represent the individual products and quantities that make up the order.

List of localized fields for the resource.

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.

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.

A list of reasons why the order can't be edited. For example, canceled orders can't be edited.

The application acting as the Merchant of Record for the order. The Merchant of Record is responsible for tax collection and remittance.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

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.

The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.

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 object.

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.

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.

The total amount of duties calculated when an order was created, before any modifications. Modifications include returns, refunds, order edits, and cancellations. Use currentTotalDutiesSet to retrieve the current duties amount after adjustments.

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.

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.

A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)".

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.

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.

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.

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.

The date and time in ISO 8601 format when the order was processed. This date and time might not match the date and time when the order was created.

The sales channel that the order was created from, such as the Online Store or Shopify POS.

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.

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.

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.

A list of refunds that have been applied to the order. Refunds represent money returned to customers for returned items, cancellations, or adjustments.

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.

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.

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.

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.

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.

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.

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.

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.

A summary of all shipping costs on the order. Aggregates shipping charges, discounts, and taxes to provide a single view of delivery costs.

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.

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.

A unique POS or third party order identifier. For example, "1234-12-1000" or "111-98567-54". The receiptNumber field is derived from this value for POS orders.

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.

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.

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.

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.

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.

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.

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 mutation.

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.

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.

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.

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.

The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns.

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.

The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts.

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).

The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts.

The total amount received from the customer before returns, in shop and presentment currencies.

The total amount that was refunded, in shop and presentment currencies.

The total amount of shipping that was refunded, in shop and presentment currencies.

The total shipping costs returned to the customer, in shop and presentment currencies. This includes fees and any related discounts that were refunded.

The total tax amount before returns, in shop and presentment currencies.

The sum of all tip amounts for the order, in shop and presentment currencies.

The total weight of the order before returns, in grams.

A list of transactions associated with the order.

The number of transactions associated with the order.

Whether no payments have been made for the order.

The date and time in ISO 8601 format when the order was last modified.

The text content of the page, complete with HTML markup.

The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.

The date and time (ISO 8601 format) of the page creation.

A default cursor that returns the single next record, sorted ascending by ID.

The paginated list of events associated with the host subject.

A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle.

A globally-unique ID.

Whether or not the page is visible.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.

The suffix of the template that's used to render the page.

Title of the page.

The published translations associated with the resource.

The date and time (ISO 8601 format) of the latest page update.

The number of publications that a resource is published to, without feedback errors.

A list of components that are associated with a product in a bundle.

The category of a product from Shopify's Standard Product Taxonomy.

A list of collections that include the product.

A special product type that combines separate products from a store into a single product listing. Combined listings are connected by a shared option, such as color, model, or dimension.

The role of the product in a combined listing.

If null, then the product isn't part of any combined listing.