collections
Returns a list of collections.
CollectionConnection arguments
- Anchor to afterafter•
The elements that come after the specified cursor.
- Anchor to beforebefore•
The elements that come before the specified cursor.
- Anchor to firstfirst•
The first
nelements from the paginated list.- Anchor to lastlast•
The last
nelements from the paginated list.- Anchor to queryquery•
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to collection_type•string
customsmart- Anchor to handle•string
- Anchor to product_id•id
Filter by collections containing a product by its ID.
- Anchor to product_publication_status•string
Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of the channel
appID (Channel.app.id) and one of the valid values.approvedrejectedneeds_actionawaiting_reviewpublisheddemotedscheduledprovisionally_publishedpublishable_status:189769876-approved- Anchor to publishable_status•string
Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of either the channel
appID (Channel.app.id) or channelnameand one of the valid values.online_store_channelpublishedunpublishedvisibleunavailablehiddenintendedvisiblepublishable_status:publishedpublishable_status:189769876:visiblepublishable_status:pos:hidden- Anchor to published_at•time
Filter by the date and time when the collection was published to the Online Store.
- Anchor to published_status•string
Filter by the published status of the resource on a channel, such as the online store.
unsetpendingapprovednot approvedpublished_status:approved- Anchor to title•string
- Anchor to updated_at•time
Example:
Valid values:
Valid values:
Example:
Valid values:
Example:
Valid values:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to savedSearchIdsaved•
Search Id The ID of a saved search. The search’s query string is used as the query argument.
- Anchor to sortKeysort•
Key CollectionSort Default:IDKeys Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Anchor to Possible returnsPossible returns
- Anchor to edgesedges•[Collection
Edge!]! non-null The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Collection!]!non-null
A list of nodes that are contained in CollectionEdge. 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.
- Anchor to pageInfopage•
Info PageInfo! non-null An object that’s used to retrieve cursor information about the current page.