Choose a version:

catalogs

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 type and use the query argument to search and filter by additional criteria.

Learn more about Shopify Catalogs.

Anchor to Arguments

CatalogConnection arguments

•CatalogConnection!

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

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.
Anchor to app_id •id
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to id •id: Filter by id range.
Anchor to managed_country_id •id
Anchor to market_id •id
Anchor to status •string
Anchor to title •string

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•CatalogSortKeys

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 typetype

•CatalogType

Default:null

The type of the catalogs to be returned.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[CatalogEdge!]! 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 pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Filter catalogs by type

Query

query {
  catalogs(first: 3, type: MARKET) {
    nodes {
      id
      title
      status
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { catalogs(first: 3, type: MARKET) { nodes { id title status } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    catalogs(first: 3, type: MARKET) {
      nodes {
        id
        title
        status
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    catalogs(first: 3, type: MARKET) {
      nodes {
        id
        title
        status
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    catalogs(first: 3, type: MARKET) {
      nodes {
        id
        title
        status
      }
    }
  }`,
});

Response

{
  "catalogs": {
    "nodes": [
      {
        "id": "gid://shopify/MarketCatalog/1068177673",
        "title": "NA Market",
        "status": "ACTIVE"
      },
      {
        "id": "gid://shopify/MarketCatalog/1068177676",
        "title": "Asia Market",
        "status": "DRAFT"
      },
      {
        "id": "gid://shopify/MarketCatalog/1068177677",
        "title": "Scandinavia Market",
        "status": "ARCHIVED"
      }
    ]
  }
}

List the first three catalogs in the shop

Query

query {
  catalogs(first: 3) {
    nodes {
      id
      title
      status
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { catalogs(first: 3) { nodes { id title status } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    catalogs(first: 3) {
      nodes {
        id
        title
        status
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    catalogs(first: 3) {
      nodes {
        id
        title
        status
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    catalogs(first: 3) {
      nodes {
        id
        title
        status
      }
    }
  }`,
});

Response

{
  "catalogs": {
    "nodes": [
      {
        "id": "gid://shopify/MarketCatalog/1068177679",
        "title": "NA Market",
        "status": "ACTIVE"
      },
      {
        "id": "gid://shopify/CompanyLocationCatalog/1068177680",
        "title": "B2B Example 1",
        "status": "DRAFT"
      },
      {
        "id": "gid://shopify/AppCatalog/1068177681",
        "title": "App Catalog Example",
        "status": "ARCHIVED"
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

catalogs(first: 3, type: MARKET) {

nodes {

title

status

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  catalogs(first: 3, type: MARKET) {
    nodes {
      id
      title
      status
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { catalogs(first: 3, type: MARKET) { nodes { id title status } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    catalogs(first: 3, type: MARKET) {
      nodes {
        id
        title
        status
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    catalogs(first: 3, type: MARKET) {
      nodes {
        id
        title
        status
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    catalogs(first: 3, type: MARKET) {
      nodes {
        id
        title
        status
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"catalogs": {

"nodes": [

{

"id": "gid://shopify/MarketCatalog/1068177673",

"title": "NA Market",

"status": "ACTIVE"

{

"id": "gid://shopify/MarketCatalog/1068177676",

"title": "Asia Market",

"status": "DRAFT"

{

"id": "gid://shopify/MarketCatalog/1068177677",

"title": "Scandinavia Market",

"status": "ARCHIVED"

}

]

}