Catalog
An auto-generated type for paginating through multiple Catalogs.
Anchor to Fields with this connectionFields with this connection
- •OBJECT
A location or branch of a
Companythat's a customer of the shop. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.Each location can have its own
Catalogobjects that determine which products are published and their pricing. Thedetermines checkout behavior including, and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing,values, and checkout settings for theirOrderobjects.
Anchor to Queries with this connectionQueries with this connection
- •query
Returns a paginated list of catalogs for the shop. Catalogs control which products are published and how they're priced in different contexts, such as international markets (Canada vs. United States), B2B company locations (different branches of the same business), or specific sales channels (such as online store vs. POS).
Filter catalogs by
typeand use thequeryargument to search and filter by additional criteria.Learn more about Shopify Catalogs.
- Anchor to typetype•Catalog
Type Default:null The type of the catalogs to be returned.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Catalog
Key Sort Keys Default:ID 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 queryquery•String
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 app_id•id
- Anchor to company_id•id
- Anchor to company_location_id•id
- Anchor to managed_country_id•id
- Anchor to market_id•id
- Anchor to status•string
- Anchor to title•string
Example:
Arguments
Anchor to Possible returnsPossible returns
- Anchor to edgesedges•[Catalog
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•[Catalog!]!non-null
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.
- Anchor to pageInfopage•Page
Info Info! non-null An object that’s used to retrieve cursor information about the current page.