Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.
Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.
Collections can also be created for a custom group of products. These are called custom or manual collections.
A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.
descriptionHtml•
HTML!
non-null
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.
events•
EventConnection!
non-null
The paginated list of events associated with the host subject.
feedback•
ResourceFeedback
Information about the collection that's provided through resource feedback.
handle•
String!
non-null
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.
hasProduct•
Boolean!
non-null
Whether the collection includes the specified product.
id•
ID!
non-null
A globally-unique ID.
image•
Image
The image associated with the collection.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
products•
ProductConnection!
non-null
The products that are included in the collection.
productsCount•
Count
The number of products in the collection.
publishedOnCurrentPublication•
Boolean!
non-null
Whether the resource is published to the app's
publication.
For example, the resource might be published to the app's online store channel.
publishedOnPublication•
Boolean!
non-null
Whether the resource is published to a specified
publication.
resourcePublications•
ResourcePublicationConnection!
non-null
The list of resources that are published to a
publication.
The list of resources that are either published or staged to be published to a
publication.
ruleSet•
CollectionRuleSet
For a smart (automated) collection, specifies the rules that determine whether a product is included.
seo•
SEO!
non-null
If the default SEO fields for page title and description have been modified, contains the modified information.
sortOrder•
CollectionSortOrder!
non-null
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.
templateSuffix•
String
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.
title•
String!
non-null
The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.
translations•
[Translation!]!
non-null
The published translations associated with the resource.
unpublishedPublications•
PublicationConnection!
non-null
The list of publications
that the resource isn't published to.
updatedAt•
DateTime!
non-null
The date and time (ISO 8601 format) when the collection was last modified.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
publicationCount•
Int!
non-nullDeprecated
The number of
publications
that a resource is published to, without
feedback errors. Use resourcePublicationsCount instead.
publications•
CollectionPublicationConnection!
non-nullDeprecated
The channels where the collection is published. Use resourcePublications instead.
publishedOnChannel•
Boolean!
non-nullDeprecated
Whether the resource is published to a specific channel. Use publishedOnPublication instead.
publishedOnCurrentChannel•
Boolean!
non-nullDeprecated
Whether the resource is published to a
channel.
For example, the resource might be published to the online store channel. Use publishedOnCurrentPublication instead.
storefrontId•
StorefrontID!
non-nullDeprecated
The Storefront GraphQL API ID of the Collection.
As of the 2022-04 version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the id field's value instead. Use id instead.
unpublishedChannels•
ChannelConnection!
non-nullDeprecated
The list of channels that the resource is not published to. Use unpublishedPublications instead.
Represents information about a company which is also a customer of the shop.
contactRoles•
CompanyContactRoleConnection!
non-null
The list of roles for the company contacts.
contacts•
CompanyContactConnection!
non-null
The list of contacts in the company.
contactsCount•
Count
The number of contacts that belong to the company.
createdAt•
DateTime!
non-null
The date and time (ISO 8601 format) at which the company was created in Shopify.
customerSince•
DateTime!
non-null
The date and time (ISO 8601 format) at which the company became the customer.
defaultCursor•
String!
non-null
A default cursor that returns the single next record, sorted ascending by ID.
defaultRole•
CompanyContactRole
The role proposed by default for a contact at the company.
draftOrders•
DraftOrderConnection!
non-null
The list of the company's draft orders.
events•
EventConnection!
non-null
The paginated list of events associated with the host subject.
externalId•
String
A unique externally-supplied ID for the company.
hasTimelineComment•
Boolean!
non-null
Whether the merchant added a timeline comment to the company.
id•
ID!
non-null
A globally-unique ID.
lifetimeDuration•
String!
non-null
The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.
locations•
CompanyLocationConnection!
non-null
The list of locations in the company.
locationsCount•
Count
The number of locations that belong to the company.
mainContact•
CompanyContact
The main contact for the company.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
name•
String!
non-null
The name of the company.
note•
String
A note about the company.
orders•
OrderConnection!
non-null
The list of the company's orders.
ordersCount•
Count
The total number of orders placed for this company, across all its locations.
totalSpent•
MoneyV2!
non-null
The total amount spent by this company, across all its locations.
updatedAt•
DateTime!
non-null
The date and time (ISO 8601 format) at which the company was last modified.
contactCount•
Int!
non-nullDeprecated
The number of contacts that belong to the company. Use contactsCount instead.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
Represents information about a customer of the shop, such as the customer's contact details, their order
history, and whether they've agreed to receive marketing material by email.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
addresses•
[MailingAddress!]!
non-null
A list of addresses associated with the customer.
addressesV2•
MailingAddressConnection!
non-null
The addresses associated with the customer.
amountSpent•
MoneyV2!
non-null
The total amount that the customer has spent on orders in their lifetime.
canDelete•
Boolean!
non-null
Whether the merchant can delete the customer from their store.
A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an
order, they can't be deleted from a store.
companyContactProfiles•
[CompanyContact!]!
non-null
A list of the customer's company contact profiles.
createdAt•
DateTime!
non-null
The date and time when the customer was added to the store.
dataSaleOptOut•
Boolean!
non-null
Whether the customer has opted out of having their data sold.
defaultAddress•
MailingAddress
The default address associated with the customer.
defaultEmailAddress•
CustomerEmailAddress
The customer's default email address.
defaultPhoneNumber•
CustomerPhoneNumber
The customer's default phone number.
displayName•
String!
non-null
The full name of the customer, based on the values for first_name and last_name. If the first_name and
last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
events•
EventConnection!
non-null
A list of events associated with the customer.
firstName•
String
The customer's first name.
id•
ID!
non-null
A globally-unique ID.
image•
Image!
non-null
The image associated with the customer.
lastName•
String
The customer's last name.
lastOrder•
Order
The customer's last order.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
lifetimeDuration•
String!
non-null
The amount of time since the customer was first added to the store.
Example: 'about 12 years'.
locale•
String!
non-null
The customer's locale.
mergeable•
CustomerMergeable!
non-null
Whether the customer can be merged with another customer.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
multipassIdentifier•
String
A unique identifier for the customer that's used with Multipass login.
note•
String
A note about the customer.
numberOfOrders•
UnsignedInt64!
non-null
The number of orders that the customer has made at the store in their lifetime.
orders•
OrderConnection!
non-null
A list of the customer's orders.
paymentMethods•
CustomerPaymentMethodConnection!
non-null
A list of the customer's payment methods.
productSubscriberStatus•
CustomerProductSubscriberStatus!
non-null
Possible subscriber states of a customer defined by their subscription contracts.
state•
CustomerState!
non-null
The state of the customer's account with the shop.
Please note that this only meaningful when Classic Customer Accounts is active.
statistics•
CustomerStatistics!
non-null
The statistics for a given customer.
storeCreditAccounts•
StoreCreditAccountConnection!
non-null
Returns a list of store credit accounts that belong to the owner resource.
A store credit account owner can hold multiple accounts each with a different currency.
subscriptionContracts•
SubscriptionContractConnection!
non-null
A list of the customer's subscription contracts.
tags•
[String!]!
non-null
A comma separated list of tags that have been added to the customer.
taxExempt•
Boolean!
non-null
Whether the customer is exempt from being charged taxes on their orders.
taxExemptions•
[TaxExemption!]!
non-null
The list of tax exemptions applied to the customer.
updatedAt•
DateTime!
non-null
The date and time when the customer was last updated.
verifiedEmail•
Boolean!
non-null
Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.
email•
String
Deprecated
The customer's email address. Use defaultEmailAddress.emailAddress instead.
emailMarketingConsent•
CustomerEmailMarketingConsentState
Deprecated
The current email marketing state for the customer.
If the customer doesn't have an email address, then this property is null. Use defaultEmailAddress.marketingState, defaultEmailAddress.marketingOptInLevel, defaultEmailAddress.marketingUpdatedAt, and defaultEmailAddress.sourceLocation instead.
hasTimelineComment•
Boolean!
non-nullDeprecated
Whether the merchant has added timeline comments about the customer on the customer's page. To query for comments on the timeline, use the events connection and a query argument containing verb:comment, or look for a CommentEvent in the __typename of events.
market•
Market
Deprecated
The market that includes the customer’s default address. This market field will be removed in a future version of the API.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
phone•
String
Deprecated
The customer's phone number. Use defaultPhoneNumber.phoneNumber instead.
smsMarketingConsent•
CustomerSmsMarketingConsentState
Deprecated
The current SMS marketing state for the customer's phone number.
If the customer does not have a phone number, then this property is null. Use defaultPhoneNumber.marketingState, defaultPhoneNumber.marketingOptInLevel, defaultPhoneNumber.marketingUpdatedAt, defaultPhoneNumber.marketingCollectedFrom, and defaultPhoneNumber.sourceLocation instead.
unsubscribeUrl•
URL!
non-nullDeprecated
The URL to unsubscribe the customer from the mailing list. Use defaultEmailAddress.marketingUnsubscribeUrl instead.
validEmailAddress•
Boolean!
non-nullDeprecated
Whether the email address is formatted correctly.
Returns true when the email is formatted correctly and
belongs to an existing domain. This doesn't guarantee that
the email address actually exists. Use defaultEmailAddress.validFormat instead.
A word or phrase to share the nature or contents of a media.
createdAt•
DateTime!
non-null
The date and time (ISO 8601 format) when the file was created.
fileErrors•
[FileError!]!
non-null
Any errors that have occurred on the file.
fileStatus•
FileStatus!
non-null
The status of the file.
id•
ID!
non-null
A globally-unique ID.
image•
Image
The image for the media. Returns null until status is READY.
mediaContentType•
MediaContentType!
non-null
The media content type.
mediaErrors•
[MediaError!]!
non-null
Any errors which have occurred on the media.
mediaWarnings•
[MediaWarning!]!
non-null
The warnings attached to the media.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
mimeType•
String
The MIME type of the image.
originalSource•
MediaImageOriginalSource
The original source of the image.
preview•
MediaPreviewImage
The preview image for the media.
status•
MediaStatus!
non-null
Current status of the media.
updatedAt•
DateTime!
non-null
The date and time (ISO 8601 format) when the file was last updated.
An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the Order object.
Learn more about
editing an existing order with the GraphQL Admin API.
Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older orders,
then you need to request access to all orders. If your app is granted
access, then you can add the read_all_orders scope to your app along with read_orders or write_orders.
Private apps are not affected by this change and are automatically granted the scope.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
additionalFees•
[AdditionalFee!]!
non-null
A list of additional fees applied to the order.
agreements•
SalesAgreementConnection!
non-null
A list of sales agreements associated with the order.
alerts•
[ResourceAlert!]!
non-null
A list of messages that appear on the order page in the Shopify admin.
app•
OrderApp
The application that created the order.
billingAddress•
MailingAddress
The billing address of the customer.
billingAddressMatchesShippingAddress•
Boolean!
non-null
Whether the billing address matches the shipping address.
cancellation•
OrderCancellation
Cancellation details for the order.
cancelledAt•
DateTime
The date and time when the order was canceled.
Returns null if the order wasn't canceled.
cancelReason•
OrderCancelReason
The reason provided when the order was canceled.
Returns null if the order wasn't canceled.
canMarkAsPaid•
Boolean!
non-null
Whether the order can be manually marked as paid.
canNotifyCustomer•
Boolean!
non-null
Whether a customer email exists for the order.
capturable•
Boolean!
non-null
Whether payment for the order can be captured.
cartDiscountAmountSet•
MoneyBag
The total order-level discount amount, before returns, in shop and presentment currencies.
channelInformation•
ChannelInformation
Details about the channel that created the order.
clientIp•
String
The IP address of the API client that created the order.
closed•
Boolean!
non-null
Whether the order is closed.
closedAt•
DateTime
The date and time when the order was closed.
Returns null if the order isn't closed.
confirmationNumber•
String
A randomly generated alpha-numeric identifier for the order that may be shown to the customer
instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ".
This value isn't guaranteed to be unique.
confirmed•
Boolean!
non-null
Whether inventory has been reserved for the order.
createdAt•
DateTime!
non-null
Date and time when the order was created in Shopify.
currencyCode•
CurrencyCode!
non-null
The shop currency when the order was placed.
currentCartDiscountAmountSet•
MoneyBag!
non-null
The current order-level discount amount after all order updates, in shop and presentment currencies.
currentShippingPriceSet•
MoneyBag!
non-null
The current shipping price after applying refunds and discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.
currentSubtotalLineItemsQuantity•
Int!
non-null
The sum of the quantities for all line items that contribute to the order's current subtotal price.
currentSubtotalPriceSet•
MoneyBag!
non-null
The sum of the prices for all line items after discounts and returns, in shop and presentment currencies.
If taxesIncluded is true, then the subtotal also includes tax.
currentTaxLines•
[TaxLine!]!
non-null
A list of all tax lines applied to line items on the order, after returns.
Tax line prices represent the total price for all tax lines with the same rate and title.
currentTotalAdditionalFeesSet•
MoneyBag
The total amount of additional fees after returns, in shop and presentment currencies.
Returns null if there are no additional fees for the order.
currentTotalDiscountsSet•
MoneyBag!
non-null
The total amount discounted on the order after returns, in shop and presentment currencies.
This includes both order and line level discounts.
currentTotalDutiesSet•
MoneyBag
The total amount of duties after returns, in shop and presentment currencies.
Returns null if duties aren't applicable.
currentTotalPriceSet•
MoneyBag!
non-null
The total price of the order, after returns, in shop and presentment currencies.
This includes taxes and discounts.
currentTotalTaxSet•
MoneyBag!
non-null
The sum of the prices of all tax lines applied to line items on the order, after returns, in shop and presentment currencies.
currentTotalWeight•
UnsignedInt64!
non-null
The total weight of the order after returns, in grams.
customAttributes•
[Attribute!]!
non-null
A list of additional merchant-facing details that have been added to the order. For example, whether an order is a customer's first.
customer•
Customer
The customer that placed the order.
customerAcceptsMarketing•
Boolean!
non-null
Whether the customer agreed to receive marketing materials.
customerJourneySummary•
CustomerJourneySummary
The customer's visits and interactions with the online store before placing the order.
customerLocale•
String
A two-letter or three-letter language code, optionally followed by a region modifier.
discountApplications•
DiscountApplicationConnection!
non-null
A list of discounts that are applied to the order, not including order edits and refunds.
discountCode•
String
The discount code used for the order.
discountCodes•
[String!]!
non-null
The discount codes used for the order.
displayAddress•
MailingAddress
The primary address of the customer.
Returns null if neither the shipping address nor the billing address was provided.
displayFinancialStatus•
OrderDisplayFinancialStatus
The financial status of the order that can be shown to the merchant.
This field doesn't capture all the details of an order's financial state. It should only be used for display summary purposes.
displayFulfillmentStatus•
OrderDisplayFulfillmentStatus!
non-null
The fulfillment status for the order that can be shown to the merchant.
This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes.
For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
disputes•
[OrderDisputeSummary!]!
non-null
A list of the disputes associated with the order.
dutiesIncluded•
Boolean!
non-null
Whether duties are included in the subtotal price of the order.
edited•
Boolean!
non-null
Whether the order has had any edits applied.
email•
String
The email address associated with the customer.
estimatedTaxes•
Boolean!
non-null
Whether taxes on the order are estimated.
This field returns false when taxes on the order are finalized and aren't subject to any changes.
events•
EventConnection!
non-null
A list of events associated with the order.
fulfillable•
Boolean!
non-null
Whether there are line items that can be fulfilled.
This field returns false when the order has no fulfillable line items.
For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
fulfillmentOrders•
FulfillmentOrderConnection!
non-null
A list of fulfillment orders for a specific order.
FulfillmentOrder API access scopes
govern which fulfillments orders are returned.
An API client will only receive a subset of the fulfillment orders which belong to an order
if they don't have the necessary access scopes to view all of the fulfillment orders.
In the case that an API client does not have the access scopes necessary to view
any of the fulfillment orders that belong to an order, an empty array will be returned.
fulfillments•
[Fulfillment!]!
non-null
List of shipments for the order.
fulfillmentsCount•
Count
The count of fulfillments including the cancelled fulfillments.
fullyPaid•
Boolean!
non-null
Whether the order has been paid in full.
hasTimelineComment•
Boolean!
non-null
Whether the merchant added a timeline comment to the order.
id•
ID!
non-null
A globally-unique ID.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
lineItems•
LineItemConnection!
non-null
A list of the order's line items.
localizedFields•
LocalizedFieldConnection!
non-null
List of localized fields for the resource.
merchantBusinessEntity•
BusinessEntity!
non-null
The merchant's business entity associated with the order.
merchantEditable•
Boolean!
non-null
Whether the order can be edited by the merchant. For example, canceled orders can’t be edited.
merchantEditableErrors•
[String!]!
non-null
A list of reasons why the order can't be edited. For example, "Canceled orders can't be edited".
merchantOfRecordApp•
OrderApp
The application acting as the Merchant of Record for the order.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
name•
String!
non-null
The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page.
For example, "#1001", "EN1001", or "1001-A".
This value isn't unique across multiple stores.
netPaymentSet•
MoneyBag!
non-null
The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.
nonFulfillableLineItems•
LineItemConnection!
non-null
A list of line items that can't be fulfilled.
For example, tips and fully refunded line items can't be fulfilled.
For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
note•
String
The contents of the note associated with the order.
originalTotalAdditionalFeesSet•
MoneyBag
The total amount of additional fees at the time of order creation, in shop and presentment currencies.
Returns null if additional fees aren't applicable.
originalTotalDutiesSet•
MoneyBag
The total amount of duties at the time of order creation, in shop and presentment currencies.
Returns null if duties aren't applicable.
originalTotalPriceSet•
MoneyBag!
non-null
The total price of the order at the time of order creation, in shop and presentment currencies.
paymentCollectionDetails•
OrderPaymentCollectionDetails!
non-null
The payment collection details for the order.
paymentGatewayNames•
[String!]!
non-null
A list of the names of all payment gateways used for the order.
For example, "Shopify Payments" and "Cash on Delivery (COD)".
paymentTerms•
PaymentTerms
The payment terms associated with the order.
phone•
String
The phone number associated with the customer.
poNumber•
String
The PO number associated with the order.
presentmentCurrencyCode•
CurrencyCode!
non-null
The payment CurrencyCode of the customer for the order.
processedAt•
DateTime!
non-null
The date and time when the order was processed.
This date and time might not match the date and time when the order was created.
publication•
Publication
The publication that the order was created from.
purchasingEntity•
PurchasingEntity
The purchasing entity for the order.
refundable•
Boolean!
non-null
Whether the order can be refunded.
refundDiscrepancySet•
MoneyBag!
non-null
The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.
refunds•
[Refund!]!
non-null
A list of refunds that have been applied to the order.
registeredSourceUrl•
URL
The URL of the source that the order originated from, if found in the domain registry.
requiresShipping•
Boolean!
non-null
Whether the order has shipping lines or at least one line item on the order that requires shipping.
restockable•
Boolean!
non-null
Whether any line item on the order can be restocked.
retailLocation•
Location
The physical location where a retail order is created or completed, except for draft POS orders completed via the “mark as paid” flow in Admin, which return null. Transactions associated with the order might have been processed at a different location.
returns•
ReturnConnection!
non-null
A list of returns for the order.
returnStatus•
OrderReturnStatus!
non-null
The order's aggregated return status for display purposes.
risk•
OrderRiskSummary!
non-null
The risk characteristics for the order.
shippingAddress•
MailingAddress
The mailing address of the customer.
shippingLine•
ShippingLine
A summary of all shipping costs on the order.
shippingLines•
ShippingLineConnection!
non-null
A list of the order's shipping lines.
shopifyProtect•
ShopifyProtectOrderSummary
The Shopify Protect details for the order. If Shopify Protect is disabled for the shop, then this will be null.
sourceIdentifier•
String
A unique POS or third party order identifier.
For example, "1234-12-1000" or "111-98567-54". The receipt_number field is derived from this value for POS orders.
sourceName•
String
The name of the source associated with the order.
staffMember•
StaffMember
The staff member associated with the order.
statusPageUrl•
URL!
non-null
The URL where the customer can check the order's current status.
subtotalLineItemsQuantity•
Int!
non-null
The sum of the quantities for all line items that contribute to the order's subtotal price.
subtotalPriceSet•
MoneyBag
The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies.
If taxesIncluded is true, then the subtotal also includes tax.
suggestedRefund•
SuggestedRefund
A suggested refund for the order.
tags•
[String!]!
non-null
A comma separated list of tags associated with the order. Updating tags overwrites
any existing tags that were previously added to the order. To add new tags without overwriting
existing tags, use the tagsAdd
mutation.
taxesIncluded•
Boolean!
non-null
Whether taxes are included in the subtotal price of the order.
taxExempt•
Boolean!
non-null
Whether taxes are exempt on the order.
taxLines•
[TaxLine!]!
non-null
A list of all tax lines applied to line items on the order, before returns.
Tax line prices represent the total price for all tax lines with the same rate and title.
test•
Boolean!
non-null
Whether the order is a test.
Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
A test order can't be converted into a real order and vice versa.
totalCapturableSet•
MoneyBag!
non-null
The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies.
This amount isn't adjusted for returns.
totalCashRoundingAdjustment•
CashRoundingAdjustment!
non-null
The total rounding adjustment applied to payments or refunds for an Order involving cash payments. Applies to some countries where cash transactions are rounded to the nearest currency denomination.
totalDiscountsSet•
MoneyBag
The total amount discounted on the order before returns, in shop and presentment currencies.
This includes both order and line level discounts.
totalOutstandingSet•
MoneyBag!
non-null
The total amount not yet transacted for the order, in shop and presentment currencies.
A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).
totalPriceSet•
MoneyBag!
non-null
The total price of the order, before returns, in shop and presentment currencies.
This includes taxes and discounts.
totalReceivedSet•
MoneyBag!
non-null
The total amount received from the customer before returns, in shop and presentment currencies.
totalRefundedSet•
MoneyBag!
non-null
The total amount that was refunded, in shop and presentment currencies.
totalRefundedShippingSet•
MoneyBag!
non-null
The total amount of shipping that was refunded, in shop and presentment currencies.
totalShippingPriceSet•
MoneyBag!
non-null
The total shipping amount before discounts and returns, in shop and presentment currencies.
totalTaxSet•
MoneyBag
The total tax amount before returns, in shop and presentment currencies.
totalTipReceivedSet•
MoneyBag!
non-null
The sum of all tip amounts for the order, in shop and presentment currencies.
totalWeight•
UnsignedInt64
The total weight of the order before returns, in grams.
transactions•
[OrderTransaction!]!
non-null
A list of transactions associated with the order.
transactionsCount•
Count
The number of transactions associated with the order.
unpaid•
Boolean!
non-null
Whether no payments have been made for the order.
updatedAt•
DateTime!
non-null
The date and time when the order was modified last.
cartDiscountAmount•
Money
Deprecated
The total order-level discount amount, before returns, in shop currency. Use cartDiscountAmountSet instead.
channel•
Channel
Deprecated
The channel that created the order. Use publication instead.
customerJourney•
CustomerJourney
Deprecated
The customer's visits and interactions with the online store before placing the order. Use customerJourneySummary instead.
landingPageDisplayText•
String
Deprecated
The URL of the first page of the online store that the customer visited before they submitted the order. Use customerJourneySummary.lastVisit.landingPageHtml instead
landingPageUrl•
URL
Deprecated
The first page of the online store that the customer visited before they submitted the order. Use customerJourneySummary.lastVisit.landingPage instead
localizationExtensions•
LocalizationExtensionConnection!
non-nullDeprecated
List of localization extensions for the resource. This connection will be removed in a future version. Use localizedFields instead.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
netPayment•
Money!
non-nullDeprecated
The net payment for the order, based on the total amount received minus the total amount refunded, in shop currency. Use netPaymentSet instead.
physicalLocation•
Location
Deprecated
The fulfillment location that was assigned when the order was created.
Orders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The Order.physicalLocation field will only point to one of these locations.
Use the FulfillmentOrder
object for up to date fulfillment location information. Use fulfillmentOrders to get the fulfillment location for the order
referralCode•
String
Deprecated
The marketing referral code from the link that the customer clicked to visit the store.
Supports the following URL attributes: "ref", "source", or "r".
For example, if the URL is {shop}.myshopify.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. Use customerJourneySummary.lastVisit.referralCode instead
referrerDisplayText•
String
Deprecated
A web domain or short description of the source that sent the customer to your online store. For example, "shopify.com" or "email". Use customerJourneySummary.lastVisit.referralInfoHtml instead
referrerUrl•
URL
Deprecated
The URL of the webpage where the customer clicked a link that sent them to your online store. Use customerJourneySummary.lastVisit.referrerUrl instead
riskLevel•
OrderRiskLevel!
non-nullDeprecated
The fraud risk level of the order. This field is deprecated in favor of OrderRiskAssessment.riskLevel which allows for more granular risk levels, including PENDING and NONE.
risks•
[OrderRisk!]!
non-nullDeprecated
A list of risks associated with the order. This field is deprecated in favor of OrderRiskAssessment, which provides enhanced capabilities such as distinguishing risks from their provider.
subtotalPrice•
Money
Deprecated
The sum of the prices for all line items after discounts and before returns, in shop currency.
If taxesIncluded is true, then the subtotal also includes tax. Use subtotalPriceSet instead.
totalCapturable•
Money!
non-nullDeprecated
The authorized amount that's uncaptured or undercaptured, in shop currency.
This amount isn't adjusted for returns. Use totalCapturableSet instead.
totalDiscounts•
Money
Deprecated
The total amount discounted on the order before returns, in shop currency.
This includes both order and line level discounts. Use totalDiscountsSet instead.
totalPrice•
Money!
non-nullDeprecated
The total price of the order, before returns, in shop currency.
This includes taxes and discounts. Use totalPriceSet instead.
totalReceived•
Money!
non-nullDeprecated
The total amount received from the customer before returns, in shop currency. Use totalReceivedSet instead.
totalRefunded•
Money!
non-nullDeprecated
The total amount that was refunded, in shop currency. Use totalRefundedSet instead.
totalShippingPrice•
Money!
non-nullDeprecated
The total shipping amount before discounts and returns, in shop currency. Use totalShippingPriceSet instead.
totalTax•
Money
Deprecated
The total tax amount before returns, in shop currency. Use totalTaxSet instead.
totalTipReceived•
MoneyV2!
non-nullDeprecated
The sum of all tip amounts for the order, in shop currency. Use totalTipReceivedSet instead.
The text content of the page, complete with HTML markup.
bodySummary•
String!
non-null
The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.
createdAt•
DateTime!
non-null
The date and time (ISO 8601 format) of the page creation.
defaultCursor•
String!
non-null
A default cursor that returns the single next record, sorted ascending by ID.
events•
EventConnection!
non-null
The paginated list of events associated with the host subject.
handle•
String!
non-null
A unique, human-friendly string for the page.
In themes, the Liquid templating language refers to a page by its handle.
id•
ID!
non-null
A globally-unique ID.
isPublished•
Boolean!
non-null
Whether or not the page is visible.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
publishedAt•
DateTime
The date and time (ISO 8601 format) when the page became or will become visible.
Returns null when the page isn't visible.
templateSuffix•
String
The suffix of the template that's used to render the page.
title•
String!
non-null
Title of the page.
translations•
[Translation!]!
non-null
The published translations associated with the resource.
updatedAt•
DateTime!
non-null
The date and time (ISO 8601 format) of the latest page update.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
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 Shopify's product model,
including limitations and considerations.
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 pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. As of API version 2025-04, only active markets are considered in the price resolution.
createdAt•
DateTime!
non-null
The date and time when the product was created.
defaultCursor•
String!
non-null
A default cursor that returns the single next record, sorted ascending by ID.
description•
String!
non-null
A single-line description of the product,
with HTML tags removed.
descriptionHtml•
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.
events•
EventConnection!
non-null
The paginated list of events associated with the host subject.
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".
giftCardTemplateSuffix•
String
The theme template that's used when customers view the gift card in a store.
handle•
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.
hasOnlyDefaultVariant•
Boolean!
non-null
Whether the product has only a single variant with the default option and value.
hasOutOfStockVariants•
Boolean!
non-null
Whether the product has variants that are out of stock.
hasVariantsThatRequiresComponents•
Boolean!
non-null
Whether at least one of the product variants requires
bundle components.
The ID of the corresponding resource in the REST Admin API.
media•
MediaConnection!
non-null
The media associated with the product. Valid media are images, 3D models, videos.
mediaCount•
Count
The total count of media
that's associated with a product.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
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.
The date and time when the product was published to the online store.
publishedInContext•
Boolean!
non-null
Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location.
publishedOnCurrentPublication•
Boolean!
non-null
Whether the resource is published to the app's
publication.
For example, the resource might be published to the app's online store channel.
publishedOnPublication•
Boolean!
non-null
Whether the resource is published to a specified
publication.
requiresSellingPlan•
Boolean!
non-null
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.
resourcePublicationOnCurrentPublication•
ResourcePublicationV2
The resource that's either published or staged to be published to
the publication.
resourcePublications•
ResourcePublicationConnection!
non-null
The list of resources that are published to a
publication.
The list of resources that are either published or staged to be published to a
publication.
restrictedForResource•
RestrictedForResource
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.
sellingPlanGroups•
SellingPlanGroupConnection!
non-null
A list of all selling plan groups
that are associated with the product either directly, or through the product's variants.
The product status,
which controls visibility across all sales channels.
tags•
[String!]!
non-null
A comma-separated list of searchable keywords that are
associated with the product. For example, a merchant might apply the sports
and summer tags to products that are associated with sportwear for summer.
Updating tags overwrites
any existing tags that were previously added to the product. To add new tags without overwriting
existing tags, use the tagsAdd
mutation.
templateSuffix•
String
The theme template that's used when customers view the product in a store.
title•
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.
The published translations associated with the resource.
unpublishedPublications•
PublicationConnection!
non-null
The list of publications
that the resource isn't published to.
updatedAt•
DateTime!
non-null
The date and time when the product was last modified.
A product's updatedAt value can change for different reasons. For example, if an order
is placed for a product that has inventory tracking set up, then the inventory adjustment
is counted as an update.
variants•
ProductVariantConnection!
non-null
A list of variants associated with the product.
If querying a single product at the root, you can fetch up to 2000 variants.
variantsCount•
Count
The number of variants
that are associated with the product.
vendor•
String!
non-null
The name of the product's vendor.
bodyHtml•
String
Deprecated
The description of the product, with
HTML tags. For example, the description might include
bold <strong></strong> and italic <i></i> text. Use descriptionHtml instead.
customProductType•
String
Deprecated
The custom product type specified by the merchant. Deprecated in API version 2022-10. Use productType instead.
descriptionPlainSummary•
String!
non-nullDeprecated
Stripped description of the product, single line with HTML tags removed.
Truncated to 60 characters. Use description instead.
featuredImage•
Image
Deprecated
The featured image for the product. Use featuredMedia instead.
images•
ImageConnection!
non-nullDeprecated
The images associated with the product. Use media instead.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
priceRange•
ProductPriceRange!
non-nullDeprecated
The price range of the product. Deprecated in API version 2020-10. Use priceRangeV2 instead.
productCategory•
ProductCategory
Deprecated
The product category specified by the merchant. Deprecated in API version 2024-04. Use category instead.
productPublications•
ProductPublicationConnection!
non-nullDeprecated
A list of the channels where the product is published. Use resourcePublications instead.
publicationCount•
Int!
non-nullDeprecated
The number of
publications
that a resource is published to, without
feedback errors. Use resourcePublicationsCount instead.
publications•
ProductPublicationConnection!
non-nullDeprecated
A list of the channels where the product is published. Use resourcePublications instead.
publishedOnChannel•
Boolean!
non-nullDeprecated
Whether the resource is published to a specific channel. Use publishedOnPublication instead.
publishedOnCurrentChannel•
Boolean!
non-nullDeprecated
Whether the resource is published to a
channel.
For example, the resource might be published to the online store channel. Use publishedOnCurrentPublication instead.
sellingPlanGroupCount•
Int!
non-nullDeprecated
A count of selling plan groups
that are associated with the product. Use sellingPlanGroupsCount instead.
standardizedProductType•
StandardizedProductType
Deprecated
The standardized product type in the Shopify product taxonomy. Deprecated in API version 2022-10. Use productCategory instead.
storefrontId•
StorefrontID!
non-nullDeprecated
The Storefront GraphQL API ID of the Product.
As of the 2022-04 version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the id field's value instead. Use id instead.
totalVariants•
Int!
non-nullDeprecated
The number of variants
that are associated with the product. Use variantsCount instead.
unpublishedChannels•
ChannelConnection!
non-nullDeprecated
The list of channels that the resource is not published to. Use unpublishedPublications instead.
Display name of the variant, based on product's title + variant's title.
events•
EventConnection!
non-null
The paginated list of events associated with the host subject.
id•
ID!
non-null
A globally-unique ID.
image•
Image
The featured image for the variant.
inventoryItem•
InventoryItem!
non-null
The inventory item, which is used to query for inventory information.
inventoryPolicy•
ProductVariantInventoryPolicy!
non-null
Whether customers are allowed to place an order for the product variant when it's out of stock.
inventoryQuantity•
Int
The total sellable quantity of the variant.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
media•
MediaConnection!
non-null
The media associated with the product variant.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
position•
Int!
non-null
The order of the product variant in the list of product variants. The first position in the list is 1.
price•
Money!
non-null
The price of the product variant in the default shop currency.
product•
Product!
non-null
The product that this variant belongs to.
productVariantComponents•
ProductVariantComponentConnection!
non-null
A list of the product variant components.
requiresComponents•
Boolean!
non-null
Whether a product variant requires components. The default value is false.
If true, then the product variant can only be purchased as a parent bundle with components and it will be omitted
from channels that don't support bundles.
selectedOptions•
[SelectedOption!]!
non-null
List of product options applied to the variant.
sellableOnlineQuantity•
Int!
non-null
The total sellable quantity of the variant for online channels.
This doesn't represent the total available inventory or capture
limitations based on customer location.
sellingPlanGroups•
SellingPlanGroupConnection!
non-null
A list of all selling plan groups defined in the current shop associated with the product variant.
sellingPlanGroupsCount•
Count
Count of selling plan groups associated with the product variant.
sku•
String
A case-sensitive identifier for the product variant in the shop.
Required in order to connect to a fulfillment service.
taxable•
Boolean!
non-null
Whether a tax is charged when the product variant is sold.
taxCode•
String
The tax code for the product variant.
title•
String!
non-null
The title of the product variant.
translations•
[Translation!]!
non-null
The published translations associated with the resource.
unitPriceMeasurement•
UnitPriceMeasurement
The unit price measurement for the variant.
updatedAt•
DateTime!
non-null
The date and time (ISO 8601 format) when the product variant was last modified.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
presentmentPrices•
ProductVariantPricePairConnection!
non-nullDeprecated
List of prices and compare-at prices in the presentment currencies for this shop. Use contextualPricing instead.
sellingPlanGroupCount•
Int!
non-nullDeprecated
Count of selling plan groups associated with the product variant. Use sellingPlanGroupsCount instead.
storefrontId•
StorefrontID!
non-nullDeprecated
The Storefront GraphQL API ID of the ProductVariant.
As of the 2022-04 version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the id field's value instead. Use id instead.
A list of nodes that are contained in MetafieldReferenceEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
