Products
- Liliia Ostrovska
List of products in the store.
Field | Description |
---|
Field | Description |
---|---|
Created at | The date and time when the product was created. |
Description | A stripped description of the product, single line with HTML tags removed. |
Description HTML | The description of the product, complete with HTML formatting. |
Gift card template suffix | The theme template used when viewing the gift card in a store. |
Handle | A unique human-friendly string of the product's title. |
Has only default variant | Whether the product has only a single variant with the default option and value. |
Has out of stock variants | Whether the product has out of stock variants. |
ID | Globally unique ID. |
Is gift card | Whether the product is a gift card. |
Legacy resource ID | The ID of the corresponding resource in the REST Admin API. |
Media count | Total count of media belonging to a product. |
Media count precision | Precision of media count, how exact is the value. |
Online store preview URL | The online store preview URL. |
Product type | The product type specified by the merchant. |
Published at | The date and time when the product was published to the Online Store. |
Status | The product status. This controls visibility across all channels. |
Storefront ID | The storefront ID of the product. |
Tags | A comma separated list of tags associated with the product. |
Template suffix | The theme template used when viewing the product in a store. |
Title | The title of the product. |
Total inventory | The quantity of inventory in stock. |
Total variants | The number of variants that are associated with the product. |
Tracks inventory | Whether inventory tracking has been enabled for the product. |
Updated at | The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update. |
Variants count precision | Precision of variants count, how exact is the value. |
Vendor | The name of the product's vendor. |
The taxonomy category specified by the merchant.
Field | Description |
---|
Field | Description |
---|---|
Full name | The full name of the taxonomy category. |
ID | Globally unique ID. |
Is archived | Whether the category is archived. |
Is leaf | Whether the category is a leaf category. A leaf category doesn't have any subcategories beneath it. |
Is root | Whether the category is a root category. A root category is at the top level of the category hierarchy and doesn't have a parent category. |
Level | The level of the category in the taxonomy tree. Levels indicate the depth of the category from the root. |
Name | The name of the taxonomy category. |
Parent ID | The ID of the category's parent category. |
A list of the collections that include the product.
Field | Description |
---|
Field | Description |
---|---|
Collection ID | Globally unique ID. |
The featured image for the product.
Field | Description |
---|
Field | Description |
---|---|
Product Image ID | Globally unique ID. |
The images associated with the product.
Field | Description |
---|
Field | Description |
---|---|
Product Image ID | Globally unique ID. |