Product
A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.
Properties
id
stringRequiredThe product's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
title
stringRequiredA title that can be displayed for easy identification of the Product.
subtitle
null | stringRequiredAn optional subtitle that can be used to further specify the Product.
description
null | stringRequiredA short description of the Product.
handle
null | stringRequiredA unique identifier for the Product (e.g. for slug structure).
is_giftcard
booleanRequiredWhether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.
Default: false
The status of the productDefault: draft
draft
The details of the product's images.
thumbnail
null | stringRequiredA URL to an image file that can be used to identify the Product.
The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.
The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.
The details of the product categories that this product belongs to.
profile_id
stringRequiredThe ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.
The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.
Available if the relation profiles
is expanded.
profiles
is expanded.weight
null | numberRequiredThe weight of the Product Variant. May be used in shipping rate calculations.
length
null | numberRequiredThe length of the Product Variant. May be used in shipping rate calculations.
height
null | numberRequiredThe height of the Product Variant. May be used in shipping rate calculations.
width
null | numberRequiredThe width of the Product Variant. May be used in shipping rate calculations.
hs_code
null | stringRequiredThe Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.
origin_country
null | stringRequiredThe country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.
mid_code
null | stringRequiredThe Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.
material
null | stringRequiredThe material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
collection_id
null | stringRequiredThe ID of the product collection that the product belongs to.
The details of the product collection that the product belongs to.
type_id
null | stringRequiredThe ID of the product type that the product belongs to.
The details of the product type that the product belongs to.
The details of the product tags used in this product.
discountable
booleanRequiredWhether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to
false
.Default: true
external_id
null | stringRequiredThe external ID of the product
metadata
null | Record<string, unknown>RequiredAn optional key-value map with additional details
The details of the sales channels this product is available in.
Was this section helpful?