Metafield Parent Resource
A resource that the metafield belongs to.
Anchor to Possible typesPossible types
- •OBJECT
An article in an online store blog.
- •Article
Author The article's author.
- Anchor to blogblog•Blog!non-null
The blog that the article belongs to.
- Anchor to commentscomments•Comment
Connection! non-null List of comments posted on the article.
- Anchor to contentcontent•String!non-null
Stripped content of the article, single line with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to contentHtmlcontent•HTML!
Html non-null The content of the article, complete with HTML formatting.
- Anchor to excerptexcerpt•String
Stripped excerpt of the article, single line with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to excerptHtmlexcerpt•HTML
Html The excerpt of the article, complete with HTML formatting.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the Article automatically generated from its title.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image associated with the article.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStoreUrlonline•URL
Store Url The URL used for viewing the resource on the shop's Online Store. Returns
null
if the resource is currently not published to the Online Store sales channel.- Anchor to publishedAtpublished•Date
At Time! non-null The date and time when the article was published.
- •SEO
The article’s SEO information.
- •[String!]!non-null
A categorization that a article can be tagged with.
- Anchor to titletitle•String!non-null
The article’s name.
- Anchor to trackingParameterstracking•String
Parameters URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.
- •Article
Author! non-nullDeprecated
- •Article
- •OBJECT
An online store blog.
- Anchor to articleByHandlearticle•Article
By Handle Find an article by its handle.
- Anchor to articlesarticles•Article
Connection! non-null List of the blog's articles.
- •[Article
Author!]! non-null The authors who have contributed to the blog.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the Blog automatically generated from its title.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStoreUrlonline•URL
Store Url The URL used for viewing the resource on the shop's Online Store. Returns
null
if the resource is currently not published to the Online Store sales channel.- •SEO
The blog's SEO information.
- Anchor to titletitle•String!non-null
The blogs’s title.
- •OBJECT
A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. Learn how to interact with a cart during a customer's session.
- Anchor to appliedGiftCardsapplied•[Applied
Gift Cards Gift Card!]! non-null The gift cards that have been applied to the cart.
- Anchor to attributeattribute•Attribute
An attribute associated with the cart.
- Anchor to attributesattributes•[Attribute!]!non-null
The attributes associated with the cart. Attributes are represented as key-value pairs.
- Anchor to buyerIdentitybuyer•Cart
Identity Buyer Identity! non-null Information about the buyer that's interacting with the cart.
- Anchor to checkoutUrlcheckout•URL!
Url non-null The URL of the checkout for the cart.
- Anchor to costcost•Cart
Cost! non-null The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The
cost
field uses thefield to determine international pricing.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the cart was created.
- Anchor to deliveryGroupsdelivery•Cart
Groups Delivery Group Connection! non-null The delivery groups available for the cart, based on the buyer identity default delivery address preference or the default address of the logged-in customer.
- Anchor to discountAllocationsdiscount•[Cart
Allocations Discount Allocation!]! non-null The discounts that have been applied to the entire cart.
- Anchor to discountCodesdiscount•[Cart
Codes Discount Code!]! non-null The case-insensitive discount codes that the customer added at checkout.
- •ID!non-null
A globally-unique ID.
- Anchor to lineslines•Base
Cart Line Connection! non-null A list of lines containing information about the items the customer intends to purchase.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to notenote•String
A note that's associated with the cart. For example, the note can be a personalized message to the buyer.
- Anchor to totalQuantitytotal•Int!
Quantity non-null The total number of items in the cart.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the cart was updated.
- Anchor to estimatedCostestimated•Cart
Cost Estimated Cost! non-nullDeprecated
- •OBJECT
A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.
- Anchor to descriptiondescription•String!non-null
Stripped description of the collection, single line with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to descriptionHtmldescription•HTML!
Html non-null The description of the collection, complete with HTML formatting.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
Image associated with the collection.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStoreUrlonline•URL
Store Url The URL used for viewing the resource on the shop's Online Store. Returns
null
if the resource is currently not published to the Online Store sales channel.- Anchor to productsproducts•Product
Connection! non-null List of products in the collection.
- •SEO!non-null
The collection's SEO information.
- Anchor to titletitle•String!non-null
The collection’s name. Limit of 255 characters.
- Anchor to trackingParameterstracking•String
Parameters URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the collection was last modified.
- •OBJECT
Represents information about a company which is also a customer of the shop.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company was created in Shopify.
- Anchor to externalIdexternal•String
Id A unique externally-supplied ID for the company.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namename•String!non-null
The name of the company.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company was last modified.
- •OBJECT
A company's location.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company location was created in Shopify.
- Anchor to externalIdexternal•String
Id A unique externally-supplied ID for the company.
- •ID!non-null
A globally-unique ID.
- Anchor to localelocale•String
The preferred locale of the company location.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namename•String!non-null
The name of the company location.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company location was last modified.
- •OBJECT
A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.
- Anchor to acceptsMarketingaccepts•Boolean!
Marketing non-null Indicates whether the customer has consented to be sent marketing material via email.
- Anchor to addressesaddresses•Mailing
Address Connection! non-null A list of addresses for the customer.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the customer was created.
- Anchor to defaultAddressdefault•Mailing
Address Address The customer’s default address.
- Anchor to displayNamedisplay•String!
Name non-null The customer’s name, email or phone number.
- Anchor to emailemail•String
The customer’s email address.
- Anchor to firstNamefirst•String
Name The customer’s first name.
- •ID!non-null
A unique ID for the customer.
- Anchor to lastNamelast•String
Name The customer’s last name.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to numberOfOrdersnumber•Unsigned
Of Orders Int64! non-null The number of orders that the customer has made at the store in their lifetime.
- Anchor to ordersorders•Order
Connection! non-null The orders associated with the customer.
- Anchor to phonephone•String
The customer’s phone number.
- •[String!]!non-null
A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the customer information was updated.
- •OBJECT
Represents a location where product inventory is held.
- Anchor to addressaddress•Location
Address! non-null The address of the location.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namename•String!non-null
The name of the location.
- •OBJECT
A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to the Shopify Markets conceptual overview.
- Anchor to handlehandle•String!non-null
A human-readable unique string for the market automatically generated from its title.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- •OBJECT
An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.
- Anchor to billingAddressbilling•Mailing
Address Address The address associated with the payment method.
- Anchor to canceledAtcanceled•Date
At Time The date and time when the order was canceled. Returns null if the order wasn't canceled.
- Anchor to cancelReasoncancel•Order
Reason Cancel Reason The reason for the order's cancellation. Returns
null
if the order wasn't canceled.- Anchor to currencyCodecurrency•Currency
Code Code! non-null The code of the currency used for the payment.
- Anchor to currentSubtotalPricecurrent•Money
Subtotal Price V2! non-null The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order.
- Anchor to currentTotalDutiescurrent•Money
Total Duties V2 The total cost of duties for the order, including refunds.
- Anchor to currentTotalPricecurrent•Money
Total Price V2! non-null The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.
- Anchor to currentTotalShippingPricecurrent•Money
Total Shipping Price V2! non-null The total cost of shipping, excluding shipping lines that have been refunded or removed. Taxes aren't included unless the order is a taxes-included order.
- Anchor to currentTotalTaxcurrent•Money
Total Tax V2! non-null The total of all taxes applied to the order, excluding taxes for returned line items.
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null A list of the custom attributes added to the order. For example, whether an order is a customer's first.
- Anchor to customerLocalecustomer•String
Locale The locale code in which this specific order happened.
- Anchor to customerUrlcustomer•URL
Url The unique URL that the customer can use to access the order.
- Anchor to discountApplicationsdiscount•Discount
Applications Application Connection! non-null Discounts that have been applied on the order.
- Anchor to editededited•Boolean!non-null
Whether the order has had any edits applied or not.
- Anchor to emailemail•String
The customer's email address.
- Anchor to financialStatusfinancial•Order
Status Financial Status The financial status of the order.
- Anchor to fulfillmentStatusfulfillment•Order
Status Fulfillment Status! non-null The fulfillment status for the order.
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•Order
Items Line Item Connection! non-null List of the order’s line items.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namename•String!non-null
Unique identifier for the order that appears on the order. For example, #1000 or _Store1001.
- Anchor to orderNumberorder•Int!
Number non-null A unique numeric identifier for the order for use by shop owner and customer.
- Anchor to originalTotalDutiesoriginal•Money
Total Duties V2 The total cost of duties charged at checkout.
- Anchor to originalTotalPriceoriginal•Money
Total Price V2! non-null The total price of the order before any applied edits.
- Anchor to phonephone•String
The customer's phone number for receiving SMS notifications.
- Anchor to processedAtprocessed•Date
At Time! non-null The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.
- Anchor to shippingAddressshipping•Mailing
Address Address The address to where the order will be shipped.
- Anchor to shippingDiscountAllocationsshipping•[Discount
Discount Allocations Allocation!]! non-null The discounts that have been allocated onto the shipping line by discount applications.
- Anchor to statusUrlstatus•URL!
Url non-null The unique URL for the order's status page.
- Anchor to subtotalPricesubtotal
Price