Navigable

The URL for the buyer to recover their checkout.

The billing address provided by the buyer. Null if the user did not provide a billing address.

The date and time when the buyer completed the checkout. Null if the checkout has not been completed.

The date and time when the checkout was created.

A list of extra information that has been added to the checkout.

The customer who created this checkout. May be null if the checkout was created from a draft order or via an app.

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

The discount codes entered by the buyer at checkout.

A globally-unique ID.

A list of the line items in this checkout.

Unique merchant-facing identifier for the checkout.

A merchant-facing note added to the checkout. Not visible to the buyer.

The shipping address to where the line items will be shipped. Null if the user did not provide a shipping address.

The sum of all items in the checkout, including discounts but excluding shipping, taxes and tips.

Whether taxes are included in line item and shipping line prices.

Individual taxes charged on the checkout.

The total amount of discounts to be applied.

The total duties applied to the checkout.

The sum of the prices of all line items in the checkout.

The sum of all items in the checkout, including discounts, shipping, taxes, and tips.

The total tax applied to the checkout.

The date and time when the checkout was most recently updated.

The name of the author of the article.

The blog containing the article.

The text of the article's body, complete with HTML markup.

List of the article's comments.

Count of comments. Limited to a maximum of 10000 by default.

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

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 article that's automatically generated from the article's title. The handle is used in the article's URL.

A globally-unique ID.

The image associated with the article.

Whether or not the article 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 metafields associated with the resource matching the supplied list of namespaces and keys.

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

A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.

A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.

The title of the article.

The published translations associated with the resource.

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

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 metafields associated with the resource matching the supplied list of namespaces and keys.

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.

The address used as billing address for the location.

The configuration for the buyer's B2B checkout.

The list of catalogs associated with the company location.

The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.

The company that the company location belongs to.

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

The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.

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

The list of draft orders for the company location.

The paginated list of events associated with the host subject.

A unique externally-supplied ID for the company location.

Whether the company location has a price list with the specified ID.

Whether the merchant added a timeline comment to the company location.

A globally-unique ID.

Whether the company location is assigned a specific catalog.

The preferred locale of the company location.

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 metafields associated with the resource matching the supplied list of namespaces and keys.

The name of the company location.

A note about the company location.

The list of orders for the company location.

The total number of orders placed for the location.

The phone number of the company location.

The list of price lists for the company location.

The list of roles assigned to the company location.

The address used as shipping address for the location.

The list of staff members assigned to the company location.

The tax settings for the company location.

The total amount spent by the location.

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

The UUID of the app extension.

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

A unique, human-friendly string for the customer account page.

The unique ID for the customer account page.

The title of the customer account page.

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

A unique, human-friendly string for the customer account page.

The unique ID for the customer account page.

The type of customer account native page.

The title of the customer account page.

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.

Whether discount codes are allowed during checkout of this draft order.

Whether all variant prices have been overridden.

The amount due later. When there are payment terms, this is the total price minus the deposit amount (if any). When there are no payment terms, this is 0.

The amount due now. When there are payment terms this is the value of the deposit (0 by default). When there are no payment terms, this is the total price.

Whether any variant prices have been overridden.

The custom order-level discount applied.

The billing address of the customer.

Whether the billing address matches the shipping address.

Whether to bypass cart validations on this draft order.

The date and time when the draft order was converted to a new order, and had it's status changed to Completed.

The date and time when the draft order was created in Shopify.

The shop currency used for calculation.

The custom information added to the draft order on behalf of the customer.

The customer who will be sent an invoice.

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

The portion required to be paid at checkout.

All discount codes applied.

The email address of the customer, which is used to send notifications.

The list of events associated with the draft order.

Whether the merchant has added timeline comments to the draft order.

A globally-unique ID.

The subject defined for the draft invoice email template.

The date and time when the invoice was last emailed to the customer.

The link to the checkout, which is sent to the customer in the invoice email.

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

The list of the line items in the draft order.

A subtotal of the line items and corresponding discounts, excluding include shipping charges, shipping discounts, taxes, or order discounts.

List of localized fields for the resource.

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 metafields associated with the resource matching the supplied list of namespaces and keys.

The identifier for the draft order, which is unique within the store. For example, #D1223.

The text from an optional note attached to the draft order.

The order that was created from the draft order.

The associated payment terms for this draft order.

The assigned phone number.

The list of platform discounts applied.

The purchase order number.

The payment currency used for calculation.

The purchasing entity.

Whether the draft order is ready and can be completed. Draft orders might have asynchronous operations that can take time to finish.

The time after which inventory will automatically be restocked.

The shipping address of the customer.

The line item containing the shipping information and costs.

The status of the draft order.

The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.

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

Whether the line item prices include taxes.

Whether the draft order is tax exempt.

The list of of taxes lines charged for each line item and shipping line.

Total discounts.

Total price of line items.

The total price, includes taxes, shipping charges, and discounts.

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.

The total shipping price.

The total tax.

The total weight in grams of the draft order.

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.

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.

Whether the draft order will be visible to the customer on the self-serve portal.

The list of warnings raised while calculating.

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 metafields associated with the resource matching the supplied list of namespaces and keys.

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.

The compare-at price range of the product in the shop's default currency.

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.

The date and time when the product was created.

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

A single-line description of the product, with HTML tags removed.

The description of the product, with HTML tags. For example, the description might include bold <strong></strong> and italic <i></i> text.

The paginated list of events associated with the host subject.

The featured media associated with the product.

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

The theme template that's used when customers view the gift card in a store.

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.

Whether the product has only a single variant with the default option and value.

Whether the product has variants that are out of stock.

Whether at least one of the product variants requires bundle components.

Learn more about store eligibility for bundles.

A globally-unique ID.

Whether the product is in a specified collection.

Whether the product is a gift card.

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

The media associated with the product. Valid media are images, 3D models, videos.

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 metafields associated with the resource matching the supplied list of namespaces and keys.

The preview URL for the online store.

The product's URL on the online store. If null, then the product isn't published to the online store sales channel.

A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).

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.

A list of products that contain at least one variant associated with at least one of the current products' variants via group relationship.

A count of unique products that contain at least one variant associated with at least one of the current products' variants via group relationship.

A list of products that has a variant that contains any of this product's variants as a component.

The product type that merchants define.

The date and time when the product was published to the online store.

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.

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.

Whether the product can only be purchased with a selling plan. 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.

The resource that's either published or staged to be published to the 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.

Whether the merchant can make changes to the product when they edit the order associated with the product. For example, a merchant might be restricted from changing product details when they edit an order.

A list of all selling plan groups that are associated with the product either directly, or through the product's variants.

A count of selling plan groups that are associated with the product.

The SEO title and description that are associated with a product.

The product status, which controls visibility across all sales channels.

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

The theme template that's used when customers view the product in a store.

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.

The quantity of inventory that's in stock.

Whether inventory tracking has been enabled for the product.

The published translations associated with the resource.

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

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.

A list of variants associated with the product. If querying a single product at the root, you can fetch up to 2000 variants.

The number of variants that are associated with the product.

The name of the product's vendor.

Whether the product variant is available for sale.

The value of the barcode associated with the product.

The compare-at price of the variant in the default shop currency.

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.

The date and time when the variant was created.

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

The delivery profile for the variant.

The delivery promise participants for the product variant.

Display name of the variant, based on product's title + variant's title.

The paginated list of events associated with the host subject.

A globally-unique ID.

The featured image for the variant.

The inventory item, which is used to query for inventory information.

Whether customers are allowed to place an order for the product variant when it's out of stock.

The total sellable quantity of the variant.

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

The media associated with the product variant.

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 metafields associated with the resource matching the supplied list of namespaces and keys.

The order of the product variant in the list of product variants. The first position in the list is 1.

The price of the product variant in the default shop currency.

The product that this variant belongs to.

A list of products that have product variants that contain this variant as a product component.

A list of the product variant components.

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.

List of product options applied to the variant.

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.

A list of all selling plan groups defined in the current shop associated with the product variant.

Count of selling plan groups associated with the product variant.

Whether to show the unit price for this product variant.

A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.

Whether a tax is charged when the product variant is sold.

The title of the product variant.

The published translations associated with the resource.

The unit price value for the variant based on the variant measurement.

The unit price measurement for the variant.

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