steampipe plugin install shopify

Table: shopify_custom_collection - Query Shopify Custom Collections using SQL

Shopify Custom Collections are a feature within Shopify that allows you to group your products into categories. These collections can be manually curated or automatically generated based on conditions you set. Custom collections are useful for organizing products by type, season, sale, and other variables that suit your store's needs.

Table Usage Guide

The shopify_custom_collection table provides insights into custom collections within Shopify. As a store manager or developer, explore collection-specific details through this table, including the collection title, product count, and related metadata. Utilize it to uncover information about collections, such as their organization, the products they contain, and their visibility status.

Examples

Basic info

Explore the basic details of your custom collections on Shopify, such as their unique identifiers, titles, handles, and the scope in which they are published. This can help you better manage and organize your collections.

select
id,
title,
handle,
published_scope
from
shopify_custom_collection;
select
id,
title,
handle,
published_scope
from
shopify_custom_collection;

Get the total number of custom collections

Discover the total number of custom collections in your Shopify store. This can be useful for managing inventory and understanding the diversity of your product offerings.

select
count(*) as total_custom_collections
from
shopify_custom_collection;
select
count(*) as total_custom_collections
from
shopify_custom_collection;

Retrieve all published custom collections

Discover the segments that are part of all the published custom collections. This is useful in understanding which collections are available for public viewing, aiding in inventory management and marketing strategies.

select
id,
title,
handle,
published
from
shopify_custom_collection
where
published = true;
select
id,
title,
handle,
published
from
shopify_custom_collection
where
published = 1;

Retrieve the custom collection details with a specific ID

Explore the specific details of a custom collection in your Shopify store using its unique ID. This is particularly useful to quickly assess the status and properties of a collection without having to manually search for it.

select
id,
title,
handle,
published
from
shopify_custom_collection
where
id = 444300460327;
select
id,
title,
handle,
published
from
shopify_custom_collection
where
id = 444300460327;

Retrieve the custom collection with a specific handle

Explore which custom collections are associated with a specific handle in Shopify to assess their publication status. This can be particularly useful for managing and organizing your collections efficiently.

select
id,
title,
handle,
published
from
shopify_custom_collection
where
handle = 'jelly';
select
id,
title,
handle,
published
from
shopify_custom_collection
where
handle = 'jelly';

Retrieve all custom collections updated after a specific date

Explore which custom collections have been updated after a certain date. This is particularly useful for keeping track of recent changes to your collections on Shopify.

select
id,
title,
handle,
published,
updated_at
from
shopify_custom_collection
where
updated_at > '2023-01-01';
select
id,
title,
handle,
published,
updated_at
from
shopify_custom_collection
where
updated_at > '2023-01-01';

Retrieve the number of custom collections published in a specific month

Discover the volume of custom collections made public within a specific month. This could be useful for understanding publishing trends or assessing the effectiveness of content strategies during that period.

select
count(*) as custom_collection_count
from
shopify_custom_collection
where
published = true
and date_trunc('month', published_at) = '2023-04-01';
select
count(*) as custom_collection_count
from
shopify_custom_collection
where
published = 1
and strftime('%Y-%m', published_at) = '2023-04';

Retrieve all custom collections that contain a specific metafield key

Discover the segments that have a particular type of metafield key in your custom collections. This can help you understand and manage the collections that share common characteristics or settings.

select
id,
title,
handle,
published,
updated_at,
jsonb_pretty(metafields)
from
shopify_custom_collection
where
metafields @> '[{"key": "description_tag"}]';
Error: The corresponding SQLite query is unavailable.

Schema for shopify_custom_collection

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
body_htmltextBody HTML of the custom collection.
custom_collection_titletextTitle of the custom collection.
handletextThe handle of the custom collection.
idbigint=The ID of the custom collection.
imagejsonbThe image of the custom collection.
metafieldsjsonbCustom collection metafields.
publishedbooleanWhether the custom collection is published or not.
published_attimestamp with time zoneThe time when the custom collection was published.
published_scopetextScope of the published custom collection.
sort_ordertextA specific sort order for the custom collection.
template_suffixtextThe template suffix of the custom collection.
titletextTitle of the resource.
updated_attimestamp with time zoneTime when the custom collection was last updated.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- shopify

You can pass the configuration to the command with the --config argument:

steampipe_export_shopify --config '<your_config>' shopify_custom_collection