Choose a version:

catalog

query

Retrieves a catalog by its ID. A catalog represents a list of products with publishing and pricing information, and can be associated with a context, such as a market, company location, or app.

Use the catalog query to retrieve information associated with the following workflows:

Managing product publications across different contexts
Setting up contextual pricing with price lists
Managing market-specific product availability
Configuring B2B customer catalogs

There are several types of catalogs:

Learn more about catalogs for different markets.

Arguments

Anchor to idid •ID! required: The ID of the Catalog to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CatalogCatalog •Catalog: A list of products with publishing and pricing information. A catalog can be associated with a specific context, such as a Market, CompanyLocation, or App.

Was this section helpful?

Monitor catalog operations and status
Retrieve a catalog with pricing details
Retrieve a catalog's title and status

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

catalog(id: "gid://shopify/Catalog/1068177658") {

title

status

operations {

__typename

... on CatalogCsvOperation {

status

}

}`,

);

const data = await response.json();

query {
  catalog(id: "gid://shopify/Catalog/1068177658") {
    id
    title
    status
    operations {
      __typename
      ... on CatalogCsvOperation {
        id
        status
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { catalog(id: \"gid://shopify/Catalog/1068177658\") { id title status operations { __typename ... on CatalogCsvOperation { id status } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    catalog(id: "gid://shopify/Catalog/1068177658") {
      id
      title
      status
      operations {
        __typename
        ... on CatalogCsvOperation {
          id
          status
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    catalog(id: "gid://shopify/Catalog/1068177658") {
      id
      title
      status
      operations {
        __typename
        ... on CatalogCsvOperation {
          id
          status
        }
      }
    }
  }`,
});

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 {
    catalog(id: "gid://shopify/Catalog/1068177658") {
      id
      title
      status
      operations {
        __typename
        ... on CatalogCsvOperation {
          id
          status
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"catalog": {

"id": "gid://shopify/AppCatalog/1068177658",

"title": "Operations Monitoring Catalog",

"status": "ACTIVE",

"operations": [

{

"__typename": "CatalogCsvOperation",

"id": "gid://shopify/CatalogCsvOperation/1065229254",

"status": "COMPLETE"

}

]

}