Products
Contains product catalog data including title, description, price, vendor, and publishing details.
Table-Specific Information
Select
The 本製品 uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The 本製品 processes other filters client-side within the 本製品.
- Id supports the '=, IN' comparison operators.
- Title supports the '=, !=' comparison operators.
- Status supports the '=, !=' comparison operators.
- Vendor supports the '=, !=' comparison operators.
- TotalInventory supports the '=, !=, <, >, >=, <=' comparison operators.
- HasOnlyDefaultVariant supports the '=, !=' comparison operators.
- UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
- CreatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
- ProductType supports the '=, !=' comparison operators.
- PublicationId supports the '=, IN' comparison operators.
- VariantId supports the '=, IN' comparison operators.
- VariantTitle supports the '=, IN' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM Products WHERE Id = 'Val1'
SELECT * FROM Products WHERE Title = 'Val1'
SELECT * FROM Products WHERE Status = 'Val1'
SELECT * FROM Products WHERE Vendor = 'Val1'
SELECT * FROM Products WHERE TotalInventory = 123
SELECT * FROM Products WHERE HasOnlyDefaultVariant = true
SELECT * FROM Products WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM Products WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM Products WHERE ProductType = 'Val1'
SELECT * FROM Products WHERE PublicationId = 'Val1'
SELECT * FROM Products WHERE VariantId = 'Val1'
SELECT * FROM Products WHERE VariantTitle = 'Val1'
Insert
The following columns can be used to create a new record:
DescriptionHtml, Title, Handle, Tags, Status, Vendor, TemplateSuffix, GiftCardTemplateSuffix, IsGiftCard, ProductType, SeoTitle, SeoDescription, RequiresSellingPlan
The following pseudo-columns can be used to create a new record:
Metafields (references Metafields), BundleComponents (references ProductBundleComponents)
Metafields Temporary Table Columns
| Column Name | Type | Description |
| Id | String | The unique ID of the metafield. |
| Namespace | String | A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. |
| Key | String | The name of the metafield. |
| Value | String | The information to be stored as metadata. |
| Type | String | The metafield's information type. |
ProductBundleComponents Temporary Table Columns
| Column Name | Type | Description |
| ComponentProductId | String | A globally-unique ID. |
| OptionSelections (references ProductBundleComponentOptionSelections) | String | The options in the parent and the component options they're connected to, along with the chosen option values that appear in the bundle. |
| Quantity | Int | The quantity of the component product set for this bundle line. It will be null if there's a quantityOption present. |
| QuantityOptionName | String | The name of the option value. |
| QuantityOptionValues | String | The quantity values of the option. |
ProductBundleComponentOptionSelections Temporary Table Columns
| Column Name | Type | Description |
| ParentOptionName | String | The product option’s name. |
| ComponentOptionId | String | A globally-unique ID. |
| Values | String | The component option values that are actively selected for this relationship. |
Update
The following columns can be updated:
DescriptionHtml, Title, Handle, Tags, Status, Vendor, TemplateSuffix, GiftCardTemplateSuffix, ProductType, SeoTitle, SeoDescription, RequiresSellingPlan
The following pseudo-columns can be used to update a record:
Metafields (references Metafields), BundleComponents (references ProductBundleComponents)
Metafields Temporary Table Columns
| Column Name | Type | Description |
| Id | String | The unique ID of the metafield. |
| Namespace | String | A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps. |
| Key | String | The name of the metafield. |
| Value | String | The information to be stored as metadata. |
| Type | String | The metafield's information type. |
ProductBundleComponents Temporary Table Columns
| Column Name | Type | Description |
| ComponentProductId | String | A globally-unique ID. |
| OptionSelections (references ProductBundleComponentOptionSelections) | String | The options in the parent and the component options they're connected to, along with the chosen option values that appear in the bundle. |
| Quantity | Int | The quantity of the component product set for this bundle line. It will be null if there's a quantityOption present. |
| QuantityOptionName | String | The name of the option value. |
| QuantityOptionValues | String | The quantity values of the option. |
ProductBundleComponentOptionSelections Temporary Table Columns
| Column Name | Type | Description |
| ParentOptionName | String | The product option’s name. |
| ComponentOptionId | String | A globally-unique ID. |
| Values | String | The component option values that are actively selected for this relationship. |
Delete
You can delete entries by specifying the following column:
Id
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally unique identifier for the product record. | |
| LegacyResourceId | Long | True |
The numeric identifier of the same product in the REST Admin API, used for backward compatibility. | |
| Description | String | True |
The full description of the product, including HTML markup that provides formatted text, images, and layout. | |
| DescriptionHtml | String | False |
The product description rendered in HTML format for display in the storefront or admin. | |
| Title | String | False |
The title of the product as displayed in the Shopify admin and storefront. | |
| Handle | String | False |
A unique, human-readable identifier based on the product title, used in URLs and Liquid templates. | |
| Tags | String | False |
A comma-separated list of descriptive tags assigned to the product. Updating this field replaces any existing tags. | |
| Status | String | False |
Indicates the current publishing state of the product, which determines its visibility across sales channels. | |
| Vendor | String | False |
The name of the product's supplier or manufacturer. | |
| OnlineStorePreviewUrl | String | True |
A temporary preview URL that allows merchants to view unpublished product changes in the online store. | |
| OnlineStoreUrl | String | True |
The live online store URL for the product. Returns null if the product is not published to the Online Store sales channel. | |
| TracksInventory | Bool | True |
Specifies whether inventory tracking is enabled for the product. | |
| TotalInventory | Int | True |
The total quantity of all variants currently available for sale across locations. | |
| HasOnlyDefaultVariant | Bool | True |
Indicates whether the product has a single default variant rather than multiple variations. | |
| HasOutOfStockVariants | Bool | True |
Indicates whether any product variants are currently out of stock. | |
| HasVariantsThatRequiresComponents | Bool | True |
Specifies whether at least one variant in the product requires bundled components for sale or fulfillment. | |
| VariantsCount | Int | True |
The total number of variants associated with this product. | |
| VariantsCountPrecision | String | True |
Indicates the accuracy of the variant count, such as 'exact' or 'estimated'. | |
| TemplateSuffix | String | False |
The name of the theme template file used to render the product page. | |
| GiftCardTemplateSuffix | String | False |
The theme template used when rendering a gift card product page. | |
| IsGiftCard | Bool | True |
Indicates whether the product is a gift card. | |
| PublishedAt | Datetime | True |
The date and time when the product was published to the Online Store. | |
| UpdatedAt | Datetime | True |
The timestamp of the most recent modification to the product record. This can change for actions like inventory updates or price changes. | |
| CreatedAt | Datetime | True |
The timestamp of when the product was initially created in Shopify. | |
| ProductType | String | False |
The merchant-defined type or category of the product, such as 'T-Shirt' or 'Home Decor'. | |
| CategoryId | String | True |
The globally unique identifier of the product's taxonomy category. | |
| CategoryName | String | True |
The display name of the product's taxonomy category, for example, 'Dog Beds'. | |
| CategoryFullName | String | True |
The complete hierarchical taxonomy name, such as 'Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds'. | |
| SeoTitle | String | False |
The search engine–optimized title for the product page. | |
| SeoDescription | String | False |
The search engine–optimized meta description for the product page. | |
| RequiresSellingPlan | Bool | False |
Indicates whether the product can only be purchased through a selling plan, such as a subscription. Subscription-only products are published only to the Online Store. | |
| SellingPlanGroupsCount | Int | True |
The number of selling plan groups associated with this product. | |
| SellingPlanGroupsCountPrecision | String | True |
Indicates the precision of the selling plan group count, such as 'exact' or 'estimated'. | |
| PriceRangeMaxVariantPriceAmount | Decimal | True |
The highest variant price for the product, expressed as a decimal monetary amount. | |
| PriceRangeMaxVariantPriceCurrencyCode | String | True |
The ISO 4217 currency code for the maximum variant price. | |
| PriceRangeMinVariantPriceAmount | Decimal | True |
The lowest variant price for the product, expressed as a decimal monetary amount. | |
| PriceRangeMinVariantPriceCurrencyCode | String | True |
The ISO 4217 currency code for the minimum variant price. | |
| CompareAtPriceRangeMaxVariantCompareAtPriceAmount | Decimal | True |
The highest compare-at price among all variants, used to show discounts. Decimal money amount. | |
| CompareAtPriceRangeMaxVariantCompareAtPriceCurrencyCode | String | True |
The ISO 4217 currency code for the highest compare-at price. | |
| CompareAtPriceRangeMinVariantCompareAtPriceAmount | Decimal | True |
The lowest compare-at price among all variants. Decimal money amount. | |
| CompareAtPriceRangeMinVariantCompareAtPriceCurrencyCode | String | True |
The ISO 4217 currency code for the lowest compare-at price. | |
| MediaCount | Int | True |
The total number of media items, such as images or videos, linked to the product. | |
| MediaCountPrecision | String | True |
Indicates the accuracy of the media count, such as 'exact' or 'estimated'. | |
| FeaturedMediaId | String | True |
The globally unique identifier of the product's featured media item. | |
| FeaturedMediaAlt | String | True |
Alternative text describing the featured media content for accessibility or SEO purposes. | |
| FeaturedMediaContentType | String | True |
The type of media associated with the featured media item, such as 'IMAGE' or 'VIDEO'. | |
| FeaturedMediaStatus | String | True |
Indicates the current processing or publication status of the featured media item. | |
| FeaturedMediaPreviewStatus | String | True |
Shows the current processing status of the preview image associated with the featured media. | |
| FeaturedMediaPreviewImageId | String | True |
The globally unique identifier of the preview image for the featured media. Returns null until the media status is READY. | |
| FeaturedMediaPreviewImageAltText | String | True |
Alternative text describing the preview image for accessibility or descriptive purposes. | |
| FeaturedMediaPreviewImageUrl | String | True |
The public URL where the preview image can be accessed. | |
| FeaturedMediaPreviewImageWidth | Int | True |
The original width of the preview image in pixels. Returns null if the image is not hosted by Shopify. | |
| FeaturedMediaPreviewImageHeight | Int | True |
The original height of the preview image in pixels. Returns null if the image is not hosted by Shopify. | |
| AvailablePublicationsCount | Int | True |
The number of active publications where the product is successfully published without feedback errors. | |
| AvailablePublicationsCountPrecision | String | True |
Indicates the precision of the available publications count, such as 'exact' or 'estimated'. | |
| PublishedOnCurrentPublication | Bool | True |
Indicates whether the product is published on the app's current publication channel, such as the Online Store. | |
| ResourcePublicationOnCurrentPublicationAutoPublish | Bool | True |
Specifies whether new products are automatically published to this publication by default. | |
| ResourcePublicationOnCurrentPublicationIsPublished | Bool | True |
Indicates whether the product's resource publication is currently live on this publication channel. | |
| ResourcePublicationOnCurrentPublicationPublishDate | Datetime | True |
The scheduled or actual date and time when the product was or will be published to the current publication. | |
| ResourcePublicationOnCurrentPublicationPublicationId | String | True |
The globally unique identifier of the publication where the product is or will be published. | |
| ResourcePublicationOnCurrentPublicationPublicationName | String | True |
The display name of the publication channel associated with the product. | |
| ResourcePublicationOnCurrentPublicationPublicationSupportsFuturePublishing | Bool | True |
Indicates whether the publication supports scheduling future publish dates. | |
| ResourcePublicationsCount | Int | True |
The total number of publications where the product is currently published without errors. | |
| ResourcePublicationsCountPrecision | String | True |
Indicates the precision or accuracy of the resource publication count. | |
| FeedbackSummary | String | True |
A concise summary of feedback or system-generated insights related to this product. | |
| FeedbackDetails | String | True |
Detailed feedback records or app-generated issue reports pertaining to this product. | |
| PublicationId | String | True |
Identifies the publication channel associated with the product for filtering or querying. | |
| VariantId | String | True |
Specifies the unique identifier of a product variant used as a filter parameter. | |
| VariantTitle | String | True |
Specifies the title of the product variant used as a filter parameter. |
Pseudo-Columns
疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。
| Name | Type | Description |
| Metafields | String |
Holds custom metadata fields that extend the product with additional attributes or integration data. |
| BundleComponents | String |
Lists the bundle components associated with this product, defining its composite structure if part of a bundle. |