Node
An object with an ID field to support global identification, in accordance with the Relay specification. This interface is used by the node and nodes queries.
Anchor to Types implemented inTypes implemented in
- •OBJECT
Details about the gift card used on the checkout.
- Anchor to amountUsedamount•Money
Used V2! non-null The amount that was taken from the gift card by applying it.
- Anchor to balancebalance•Money
V2! non-null The amount left on the gift card.
- •ID!non-null
A globally-unique ID.
- Anchor to lastCharacterslast•String!
Characters non-null The last characters of the gift card.
- Anchor to presentmentAmountUsedpresentment•Money
Amount Used V2! non-null The amount that was applied to the checkout in its currency.
- Anchor to amountUsedV2amount•Money
Used V2 V2! non-nullDeprecated - Anchor to balanceV2balance•Money
V2 V2! non-nullDeprecated
- •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 deliverydelivery•Cart
Delivery! non-null The delivery properties of the cart.
- 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
Represents information about the merchandise in the cart.
- Anchor to attributeattribute•Attribute
An attribute associated with the cart line.
- Anchor to attributesattributes•[Attribute!]!non-null
The attributes associated with the cart line. Attributes are represented as key-value pairs.
- Anchor to costcost•Cart
Line Cost! non-null The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.
- Anchor to discountAllocationsdiscount•[Cart
Allocations Discount Allocation!]! non-null The discounts that have been applied to the cart line.
- •ID!non-null
A globally-unique ID.
- Anchor to merchandisemerchandise•Merchandise!non-null
The merchandise that the buyer intends to purchase.
- Anchor to quantityquantity•Int!non-null
The quantity of the merchandise that the customer intends to purchase.
- Anchor to sellingPlanAllocationselling•Selling
Plan Allocation Plan Allocation The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.
- Anchor to estimatedCostestimated•Cart
Cost Line 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
A comment on an article.
- •Comment
Author! non-null The comment’s author.
- Anchor to contentcontent•String!non-null
Stripped content of the comment, 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 comment, complete with HTML formatting.
- •ID!non-null
A globally-unique ID.
- •Comment
- •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 main point of contact.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company contact was created in Shopify.
- •ID!non-null
A globally-unique ID.
- Anchor to localelocale•String
The company contact's locale (language).
- Anchor to titletitle•String
The company contact's job title.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company contact 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
Represents information about the grouped merchandise in the cart.
- Anchor to attributeattribute•Attribute
An attribute associated with the cart line.
- Anchor to attributesattributes•[Attribute!]!non-null
The attributes associated with the cart line. Attributes are represented as key-value pairs.
- Anchor to costcost•Cart
Line Cost! non-null The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.
- Anchor to discountAllocationsdiscount•[Cart
Allocations Discount Allocation!]! non-null The discounts that have been applied to the cart line.
- •ID!non-null
A globally-unique ID.
- Anchor to lineComponentsline•[Cart
Components Line!]! non-null The components of the line item.
- Anchor to merchandisemerchandise•Merchandise!non-null
The merchandise that the buyer intends to purchase.
- Anchor to quantityquantity•Int!non-null
The quantity of the merchandise that the customer intends to purchase.
- Anchor to sellingPlanAllocationselling•Selling
Plan Allocation Plan Allocation The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.
- Anchor to estimatedCostestimated•Cart
Cost Line Estimated Cost! non-nullDeprecated
- •OBJECT
Represents a video hosted outside of Shopify.
- •String
A word or phrase to share the nature or contents of a media.
- Anchor to embedUrlembed•URL!
Url non-null The embed URL of the video for the respective host.
- Anchor to hosthost•Media
Host! non-null The host of the external video.
- •ID!non-null
A globally-unique ID.
- Anchor to mediaContentTypemedia•Media
Content Type Content Type! non-null The media content type.
- Anchor to originUrlorigin•URL!
Url non-null The origin URL of the video on the respective host.
- Anchor to presentationpresentation•Media
Presentation The presentation for a media.
- Anchor to previewImagepreview•Image
Image The preview image for the media.
- Anchor to embeddedUrlembedded•URL!
Url non-nullDeprecated
- •OBJECT
The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON.
- •String
A word or phrase to indicate the contents of a file.
- •ID!non-null
A globally-unique ID.
- Anchor to mimeTypemime•String
Type The MIME type of the file.
- Anchor to originalFileSizeoriginal•Int
File Size The size of the original file in bytes.
- Anchor to previewImagepreview•Image
Image The preview image for the file.
- •URL
The URL of the file.
- •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
Represents a mailing address for customers and shipping.
- Anchor to address1address1•String
The first line of the address. Typically the street address or PO Box number.
- Anchor to address2address2•String
The second line of the address. Typically the number of the apartment, suite, or unit.
- Anchor to citycity•String
The name of the city, district, village, or town.
- Anchor to companycompany•String
The name of the customer's company or organization.
- Anchor to countrycountry•String
The name of the country.
- Anchor to countryCodeV2country•Country
Code V2 Code The two-letter code for the country of the address.
For example, US.
- Anchor to firstNamefirst•String
Name The first name of the customer.
- Anchor to formattedformatted•[String!]!non-null
A formatted version of the address, customized by the provided arguments.
- Anchor to withNamewith•Boolean
Name Default:false Whether to include the customer's name in the formatted address.
- Anchor to withCompanywith•Boolean
Company Default:true Whether to include the customer's company in the formatted address.
Arguments
- Anchor to formattedAreaformatted•String
Area A comma-separated list of the values for city, province, and country.
- •ID!non-null
A globally-unique ID.
- Anchor to lastNamelast•String
Name The last name of the customer.
- Anchor to latitudelatitude•Float
The latitude coordinate of the customer address.
- Anchor to longitudelongitude•Float
The longitude coordinate of the customer address.
- Anchor to namename•String
The full name of the customer, based on firstName and lastName.
- Anchor to phonephone•String
A unique phone number for the customer.
Formatted using E.164 standard. For example, +16135551111.
- Anchor to provinceprovince•String
The region of the address, such as the province, state, or district.
- Anchor to provinceCodeprovince•String
Code The alphanumeric code for the region.
For example, ON.
- •String
The zip or postal code of the address.
- Anchor to countryCodecountry•String
Code Deprecated
- •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
Represents a Shopify hosted image.
- •String
A word or phrase to share the nature or contents of a media.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image for the media.
- Anchor to mediaContentTypemedia•Media
Content Type Content Type! non-null The media content type.
- Anchor to presentationpresentation•Media
Presentation The presentation for a media.
- Anchor to previewImagepreview•Image
Image The preview image for the media.
- •OBJECT
A media presentation.
- Anchor to asJsonas•JSON
Json A JSON object representing a presentation view.
- Anchor to formatformat•Media
Presentation Format! required The format to transform the settings.
Arguments
- •ID!non-null
A globally-unique ID.
- •OBJECT
A navigation menu representing a hierarchy of hyperlinks (items).
- Anchor to handlehandle•String!non-null
The menu's handle.
- •ID!non-null
A globally-unique ID.
- Anchor to itemsitems•[Menu
Item!]! non-null The menu's child items.
- Anchor to itemsCountitems•Int!
Count non-null The count of items on the menu.
- Anchor to titletitle•String!non-null
The menu's title.
- •OBJECT
A menu item within a parent menu.
- •ID!non-null
A globally-unique ID.
- Anchor to itemsitems•[Menu
Item!]! non-null The menu item's child items.
- Anchor to resourceresource•Menu
Item Resource The linked resource.
- Anchor to resourceIdresource•ID
Id The ID of the linked resource.
- •[String!]!non-null
The menu item's tags to filter a collection.
- Anchor to titletitle•String!non-null
The menu item's title.
- Anchor to typetype•Menu
Item Type! non-null The menu item's type.
- •URL
The menu item's URL.
- •ID!
- •OBJECT
Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the storefront metafield was created.
- Anchor to descriptiondescription•String
The description of a metafield.
- •ID!non-null
A globally-unique ID.
- •String!non-null
The unique identifier for the metafield within its namespace.
- Anchor to namespacenamespace•String!non-null
The container for a group of metafields that the metafield is associated with.
- Anchor to parentResourceparent•Metafield
Resource Parent Resource! non-null The type of resource that the metafield is attached to.
- Anchor to referencereference•Metafield
Reference Returns a reference object if the metafield's type is a resource reference.
- Anchor to referencesreferences•Metafield
Reference Connection A list of reference objects if the metafield's type is a resource reference list.
- Anchor to typetype•String!non-null
The type name of the metafield. Refer to the list of supported types.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the metafield was last updated.
- Anchor to valuevalue•String!non-null
The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
- •OBJECT
An instance of a user-defined model based on a MetaobjectDefinition.
- Anchor to fieldfield•Metaobject
Field Accesses a field of the object by key.
- Anchor to fieldsfields•[Metaobject
Field!]! non-null All object fields with defined values. Omitted object keys can be assumed null, and no guarantees are made about field order.
- Anchor to handlehandle•String!non-null
The unique handle of the metaobject. Useful as a custom ID.
- •ID!non-null
A globally-unique ID.
- Anchor to onlineStoreUrlonline•URL
Store Url The URL used for viewing the metaobject on the shop's Online Store. Returns
null
if the metaobject definition doesn't have thecapability.
- •Metaobject
SEO The metaobject's SEO information. Returns
null
if the metaobject definition doesn't have therenderable
capability.- Anchor to typetype•String!non-null
The type of the metaobject. Defines the namespace of its associated metafields.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the metaobject was last updated.
- •OBJECT
Represents a Shopify hosted 3D model.
- •String
A word or phrase to share the nature or contents of a media.
- •ID!non-null
A globally-unique ID.
- Anchor to mediaContentTypemedia•Media
Content Type Content Type! non-null The media content type.
- Anchor to presentationpresentation•Media
Presentation The presentation for a media.
- Anchor to previewImagepreview•Image
Image The preview image for the media.
- Anchor to sourcessources•[Model3d
Source!]! non-null The sources for a 3d model.
- •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•Money
Price V2 Price of the order before shipping and taxes.
- Anchor to successfulFulfillmentssuccessful•[Fulfillment!]
Fulfillments List of the order’s successful fulfillments.
- Anchor to totalPricetotal•Money
Price V2! non-null The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).
- Anchor to totalRefundedtotal•Money
Refunded V2! non-null The total amount that has been refunded.
- Anchor to totalShippingPricetotal•Money
Shipping Price V2! non-null The total cost of shipping.
- Anchor to totalTaxtotal•Money
Tax V2 The total cost of taxes.
- Anchor to subtotalPriceV2subtotal•Money
Price V2 V2 Deprecated - Anchor to totalPriceV2total•Money
Price V2 V2! non-nullDeprecated - Anchor to totalRefundedV2total•Money
Refunded V2 V2! non-nullDeprecated - Anchor to totalShippingPriceV2total•Money
Shipping Price V2 V2! non-nullDeprecated - Anchor to totalTaxV2total•Money
Tax V2 V2 Deprecated
- •OBJECT
Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store.
- Anchor to bodybody•HTML!non-null
The description of the page, complete with HTML formatting.
- Anchor to bodySummarybody•String!
Summary non-null Summary of the page body.
- Anchor to createdAtcreated•Date
At Time! non-null The timestamp of the page creation.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the page 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 page's SEO information.
- Anchor to titletitle•String!non-null
The title of the page.
- 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 timestamp of the latest page update.
- •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 to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.
Learn more about working with products and collections.
- Anchor to adjacentVariantsadjacent•[Product
Variants Variant!]! non-null A list of variants whose selected options differ with the provided selected options by one, ordered by variant id. If selected options are not provided, adjacent variants to the first available variant is returned.
Note that this field returns an array of variants. In most cases, the number of variants in this array will be low. However, with a low number of options and a high number of values per option, the number of variants returned here can be high. In such cases, it recommended to avoid using this field.
This list of variants can be used in combination with the
options
field to build a rich variant picker that includes variant availability or other variant information.- Anchor to availableForSaleavailable•Boolean!
For Sale non-null Indicates if at least one product variant is available for sale.
- Anchor to categorycategory•Taxonomy
Category The category of a product from Shopify's Standard Product Taxonomy.
- Anchor to collectionscollections•Collection
Connection! non-null A list of collections that include the product.
- Anchor to compareAtPriceRangecompare•Product
At Price Range Price Range! non-null The compare-at price range of the product in the shop's default currency.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the product was created.
- Anchor to descriptiondescription•String!non-null
A single-line description of the product, 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 product, with HTML tags. For example, the description might include bold
<strong></strong>
and italic<i></i>
text.- Anchor to encodedVariantAvailabilityencoded•String
Variant Availability An encoded string containing all option value combinations with a corresponding variant that is currently available for sale.
Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0
:
,,
,-
are control characters.:
indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2.,
indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes.-
indicates a continuous range of option values. ex: 0 1-3 4Decoding process:
Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"
Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:
[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).
- Anchor to encodedVariantExistenceencoded•String
Variant Existence An encoded string containing all option value combinations with a corresponding variant.
Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0
:
,,
,-
are control characters.:
indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2.,
indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes.-
indicates a continuous range of option values. ex: 0 1-3 4Decoding process:
Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"
Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:
[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).
- Anchor to featuredImagefeatured•Image
Image The featured image for the product.
This field is functionally equivalent to
images(first: 1)
.- Anchor to handlehandle•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.- •ID!non-null
A globally-unique ID.
- Anchor to imagesimages•Image
Connection! non-null List of images associated with the product.
- Anchor to isGiftCardis•Boolean!
Gift Card non-null Whether the product is a gift card.
- Anchor to mediamedia•Media
Connection! non-null The media that are associated with the product. Valid media are images, 3D models, videos.
- 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 product's URL on the online store. If
null
, then the product isn't published to the online store sales channel.- Anchor to optionsoptions•[Product
Option!]! non-null A list of product options. The limit is defined by the shop's resource limits for product options (
).
- Anchor to priceRangeprice•Product
Range Price Range! 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.
- Anchor to productTypeproduct•String!
Type non-null The product type that merchants define.
- Anchor to publishedAtpublished•Date
At Time! non-null The date and time when the product was published to the channel.
- Anchor to requiresSellingPlanrequires•Boolean!
Selling Plan non-null Whether the product can only be purchased with a selling plan. Products that are sold on subscription (
) can be updated only for online stores. If you update a product to be subscription-only (
), then the product is unpublished from all channels, except the online store.
- Anchor to selectedOrFirstAvailableVariantselected•Product
Or First Available Variant Variant Find an active product variant based on selected options, availability or the first variant.
All arguments are optional. If no selected options are provided, the first available variant is returned. If no variants are available, the first variant is returned.
- Anchor to sellingPlanGroupsselling•Selling
Plan Groups Plan Group Connection! non-null A list of all selling plan groups that are associated with the product either directly, or through the product's variants.
- •SEO!non-null
The SEO title and description that are associated with a product.
- •[String!]!non-null
A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the
sports
andsummer
tags to products that are associated with sportwear for summer. Updatingtags
overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the GraphQL Admin API'smutation.
- Anchor to titletitle•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
.- Anchor to totalInventorytotal•Int
Inventory The quantity of inventory that's in stock.
- 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 product was last modified. A product's
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.
- Anchor to variantBySelectedOptionsvariant•Product
By Selected Options Variant Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options,
null
will be returned.- Anchor to variantsvariants•Product
Variant Connection! non-null A list of variants that are associated with the product.
- Anchor to variantsCountvariants•Count
Count The number of variants that are associated with the product.
- Anchor to vendorvendor•String!non-null
The name of the product's vendor.
- •OBJECT
Product property names like "Size", "Color", and "Material" that the customers can select. Variants are selected based on permutations of these options. 255 characters limit each.
- •ID!non-null
A globally-unique ID.
- Anchor to namename•String!non-null
The product option’s name.
- Anchor to optionValuesoption•[Product
Values Option Value!]! non-null The corresponding option value to the product option.
- Anchor to valuesvalues•[String!]!non-nullDeprecated
- •ID!
- •OBJECT
The product option value names. For example, "Red", "Blue", and "Green" for a "Color" option.
- Anchor to firstSelectableVariantfirst•Product
Selectable Variant Variant The product variant that combines this option value with the lowest-position option values for all other options.
This field will always return a variant, provided a variant including this option value exists.
- •ID!non-null
A globally-unique ID.
- Anchor to namename•String!non-null
The name of the product option value.
- Anchor to swatchswatch•Product
Option Value Swatch The swatch of the product option value.
- •OBJECT
A product variant represents a different version of a product, such as differing sizes or differing colors.
- Anchor to availableForSaleavailable•Boolean!
For Sale non-null Indicates if the product variant is available for sale.
- Anchor to barcodebarcode•String
The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.
- Anchor to compareAtPricecompare
At Price