catalogs - admin-graphql - QUERY
Version: unstable
Description:
The catalogs belonging to the shop.
Access Scopes
Arguments
-
after:
String -
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
before:
String -
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
first:
Int -
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
last:
Int -
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
query:
String -
A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
| ---- | ---- | ---- | ---- | ---- | ---- |
| default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` |
| app_id | id |
| company_id | id |
| company_location_id | id |
| id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` |
| managed_country_id | id |
| market_id | id |
| status | string |
| title | string |
You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
-
reverse:
Boolean -
Reverse the order of the underlying list.
-
sortKey:
CatalogSortKeys -
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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
-
type:
CatalogType -
The type of the catalogs to be returned.
Returns
-
edges:
CatalogEdge!
The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
-
nodes:
Catalog!
A list of nodes that are contained in CatalogEdge. 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.
-
pageInfo:
PageInfo!
An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.
Examples