Has Events
Represents an object that has a list of events.
Anchor to FieldsFields
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
Anchor to Types implemented inTypes implemented in
- •OBJECT
An article in the blogging system.
- •Article
Author The name of the author of the article.
- Anchor to blogblog•Blog!non-null
The blog containing the article.
- Anchor to bodybody•HTML!non-null
The text of the article's body, complete with HTML markup.
- Anchor to commentscomments•Comment
Connection! non-null List of the article's comments.
- Anchor to commentsCountcomments•Count
Count Count of comments. Limited to a maximum of 10000 by default.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) when the article was created.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to handlehandle•String!non-null
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.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image associated with the article.
- Anchor to isPublishedis•Boolean!
Published non-null Whether or not the article is visible.
- 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
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to publishedAtpublished•Date
At Time The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible.
- Anchor to summarysummary•HTML
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.
- •[String!]!non-null
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
- Anchor to templateSuffixtemplate•String
Suffix 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 isnull
.- Anchor to titletitle•String!non-null
The title of the article.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to updatedAtupdated•Date
At Time The date and time (ISO 8601 format) when the article was last updated.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
- •Article
- •OBJECT
Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time.
- Anchor to articlesarticles•Article
Connection! non-null List of the blog's articles.
- Anchor to articlesCountarticles•Count
Count Count of articles. Limited to a maximum of 10000 by default.
- Anchor to commentPolicycomment•Comment
Policy Policy! non-null Indicates whether readers can post comments to the blog and if comments are moderated or not.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the blog was created.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to feedfeed•Blog
Feed FeedBurner provider details. Any blogs that aren't already integrated with FeedBurner can't use the service.
- Anchor to handlehandle•String!non-null
A unique, human-friendly string for the blog. If no handle is specified, a handle will be generated automatically from the blog title. The handle is customizable and is used by the Liquid templating language to refer to the blog.
- •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
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- •[String!]!non-null
A list of tags associated with the 200 most recent blog articles.
- Anchor to templateSuffixtemplate•String
Suffix The name of the template a blog is using if it's using an alternate template. Returns
null
if a blog is using the default blog.liquid template.- Anchor to titletitle•String!non-null
The title of the blog.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to updatedAtupdated•Date
At Time The date and time when the blog was update.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
- •OBJECT
The
Collection
object represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across online stores, sales channels, and marketing campaigns.There are two types of collections:
- Custom (manual) collections: You specify the products to include in a collection.
- Smart (automated) collections: You define rules, and products matching those rules are automatically included in the collection.
The
Collection
object provides information to:- Organize products by category, season, or promotion.
- Automate product grouping using rules (for example, by tag, type, or price).
- Configure product sorting and display order (for example, alphabetical, best-selling, price, or manual).
- Manage collection visibility and publication across sales channels.
- Add rich descriptions, images, and metadata to enhance discovery.
NoteCollections can be displayed in a store with Shopify's theme system through Liquid templates and can be customized with template suffixes for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs.
Learn about using metafields with smart collections.
- Anchor to availablePublicationsCountavailable•Count
Publications Count The number of publications that a resource is published to, without feedback errors.
- Anchor to descriptiondescription•String!non-null
A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.
- 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, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to feedbackfeedback•Resource
Feedback Information about the collection that's provided through resource feedback.
- Anchor to handlehandle•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 handlesummer-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.
- Anchor to hasProducthas•Boolean!
Product non-null Whether the collection includes the specified product.
- •ID!required
The ID of the product to check.
Arguments
- •ID!
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image associated with the collection.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- 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
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to productsproducts•Product
Connection! non-null The products that are included in the collection.
- Anchor to productsCountproducts•Count
Count The number of products in the collection.
- Anchor to publishedOnCurrentPublicationpublished•Boolean!
On Current Publication 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.
- Anchor to publishedOnPublicationpublished•Boolean!
On Publication non-null Whether the resource is published to a specified publication.
- Anchor to publicationIdpublication•ID!
Id required The ID of the publication to check. For example,
.
Arguments
- Anchor to resourcePublicationsresource•Resource
Publications Publication Connection! non-null The list of resources that are published to a publication.
- Anchor to resourcePublicationsCountresource•Count
Publications Count The number of publications that a resource is published to, without feedback errors.
- Anchor to resourcePublicationsV2resource•Resource
Publications V2 Publication V2Connection! non-null The list of resources that are either published or staged to be published to a publication.
- Anchor to ruleSetrule•Collection
Set Rule Set For a smart (automated) collection, specifies the rules that determine whether a product is included.
- •SEO!non-null
If the default SEO fields for page title and description have been modified, contains the modified information.
- Anchor to sortOrdersort•Collection
Order Sort Order! 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.
- Anchor to templateSuffixtemplate•String
Suffix 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 thecollection.custom.liquid
template. If the value isnull
, then the collection is using the defaultcollection.liquid
template.- Anchor to titletitle•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.
- Anchor to translationstranslations•[Translation!]!non-null
The published translations associated with the resource.
- Anchor to unpublishedPublicationsunpublished•Publication
Publications Connection! non-null The list of publications that the resource isn't published to.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) when the collection was last modified.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated - Anchor to publicationCountpublication•Int!
Count non-nullDeprecated - Anchor to onlyPublishedonly•Boolean
Published Default:true Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
Arguments
- Anchor to publicationspublications•Collection
Publication Connection! non-nullDeprecated - Anchor to publishedOnChannelpublished•Boolean!
On Channel non-nullDeprecated - Anchor to channelIdchannel•ID!
Id required The ID of the channel to check.
Arguments
- Anchor to publishedOnCurrentChannelpublished•Boolean!
On Current Channel non-nullDeprecated - Anchor to storefrontIdstorefront•Storefront
Id ID! non-nullDeprecated - Anchor to unpublishedChannelsunpublished•Channel
Channels Connection! non-nullDeprecated
- •OBJECT
A comment on an article.
- Anchor to articlearticle•Article
The article associated with the comment.
- •Comment
Author! non-null The comment’s author.
- Anchor to bodybody•String!non-null
The content of the comment.
- Anchor to bodyHtmlbody•HTML!
Html non-null The content of the comment, complete with HTML formatting.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the comment was created.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- •ID!non-null
A globally-unique ID.
- •String
The IP address of the commenter.
- Anchor to isPublishedis•Boolean!
Published non-null Whether or not the comment is published.
- Anchor to publishedAtpublished•Date
At Time The date and time when the comment was published.
- Anchor to statusstatus•Comment
Status! non-null The status of the comment.
- Anchor to updatedAtupdated•Date
At Time The date and time when the comment was last updated.
- Anchor to userAgentuser•String
Agent The user agent of the commenter.
- •OBJECT
Represents information about a company which is also a customer of the shop.
- Anchor to contactRolescontact•Company
Roles Contact Role Connection! non-null The list of roles for the company contacts.
- Anchor to contactscontacts•Company
Contact Connection! non-null The list of contacts in the company.
- Anchor to contactsCountcontacts•Count
Count The number of contacts that belong to the company.
- 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 customerSincecustomer•Date
Since Time! non-null The date and time (ISO 8601 format) at which the company became the customer.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to defaultRoledefault•Company
Role Contact Role The role proposed by default for a contact at the company.
- Anchor to draftOrdersdraft•Draft
Orders Order Connection! non-null The list of the company's draft orders.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to externalIdexternal•String
Id A unique externally-supplied ID for the company.
- Anchor to hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether the merchant added a timeline comment to the company.
- •ID!non-null
A globally-unique ID.
- Anchor to lifetimeDurationlifetime•String!
Duration non-null The lifetime duration of the company, since it became a customer of the shop. Examples:
2 days
,3 months
,1 year
.- Anchor to locationslocations•Company
Location Connection! non-null The list of locations in the company.
- Anchor to locationsCountlocations•Count
Count The number of locations that belong to the company.
- Anchor to mainContactmain•Company
Contact Contact The main contact for the company.
- 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
Connection! 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 notenote•String
A note about the company.
- Anchor to ordersorders•Order
Connection! non-null The list of the company's orders.
- Anchor to ordersCountorders•Count
Count The total number of orders placed for this company, across all its locations.
- Anchor to totalSpenttotal•Money
Spent V2! non-null The total amount spent by this company, across all its locations.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company was last modified.
- Anchor to contactCountcontact•Int!
Count non-nullDeprecated - Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
- •OBJECT
A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.
- Anchor to billingAddressbilling•Company
Address Address The address used as billing address for the location.
- Anchor to buyerExperienceConfigurationbuyer•Buyer
Experience Configuration Experience Configuration The configuration for the buyer's B2B checkout.
- Anchor to catalogscatalogs•Catalog
Connection! non-null The list of catalogs associated with the company location.
- Anchor to catalogsCountcatalogs•Count
Count The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.
- Anchor to companycompany•Company!non-null
The company that the company location belongs to.
- 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 currencycurrency•Currency
Code! non-null The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to draftOrdersdraft•Draft
Orders Order Connection! non-null The list of draft orders for the company location.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to externalIdexternal•String
Id A unique externally-supplied ID for the company location.
- Anchor to hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether the merchant added a timeline comment to the company location.
- •ID!non-null
A globally-unique ID.
- Anchor to inCatalogin•Boolean!
Catalog non-null Whether the company location is assigned a specific catalog.
- Anchor to catalogIdcatalog•ID!
Id required The ID of the catalog.
Arguments
- 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
Connection! 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 notenote•String
A note about the company location.
- Anchor to ordersorders•Order
Connection! non-null The list of orders for the company location.
- Anchor to ordersCountorders•Count
Count The total number of orders placed for the location.
- Anchor to phonephone•String
The phone number of the company location.
- Anchor to roleAssignmentsrole•Company
Assignments Contact Role Assignment Connection! non-null The list of roles assigned to the company location.
- Anchor to shippingAddressshipping•Company
Address Address The address used as shipping address for the location.
- Anchor to staffMemberAssignmentsstaff•Company
Member Assignments Location Staff Member Assignment Connection! non-null The list of staff members assigned to the company location.
- Anchor to taxSettingstax•Company
Settings Location Tax Settings! non-null The tax settings for the company location.
- Anchor to totalSpenttotal•Money
Spent V2! non-null The total amount spent by the location.
- Anchor to updatedAtupdated
At