| id |
String |
The product's ID |
|
| title |
String |
A title that can be displayed for easy identification of the Product. |
|
| subtitle |
String |
An optional subtitle that can be used to further specify the Product. |
|
| description |
String |
A short description of the Product. |
|
| handle |
String |
A unique identifier for the Product (e.g. for slug structure). |
|
| isGiftcard |
Boolean |
Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased. |
|
| status |
StatusEnum |
The status of the product |
|
| images |
List<Image> |
Images of the Product. Available if the relation `images` is expanded. |
[optional] |
| thumbnail |
String |
A URL to an image file that can be used to identify the Product. |
|
| options |
List<ProductOption> |
The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values. Available if the relation `options` is expanded. |
[optional] |
| variants |
List<ProductVariant> |
The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values. Available if the relation `variants` is expanded. |
[optional] |
| categories |
List<ProductCategory> |
The product's associated categories. Available if the relation `categories` are expanded. |
[optional] |
| profileId |
String |
The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. |
|
| profile |
ShippingProfile |
|
[optional] |
| weight |
BigDecimal |
The weight of the Product Variant. May be used in shipping rate calculations. |
|
| length |
BigDecimal |
The length of the Product Variant. May be used in shipping rate calculations. |
|
| height |
BigDecimal |
The height of the Product Variant. May be used in shipping rate calculations. |
|
| width |
BigDecimal |
The width of the Product Variant. May be used in shipping rate calculations. |
|
| hsCode |
String |
The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. |
|
| originCountry |
String |
The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. |
|
| midCode |
String |
The 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 |
String |
The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. |
|
| collectionId |
String |
The Product Collection that the Product belongs to |
|
| collection |
ProductCollection |
|
[optional] |
| typeId |
String |
The Product type that the Product belongs to |
|
| type |
ProductType |
|
[optional] |
| tags |
List<ProductTag> |
The Product Tags assigned to the Product. Available if the relation `tags` is expanded. |
[optional] |
| discountable |
Boolean |
Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`. |
|
| externalId |
String |
The external ID of the product |
|
| salesChannels |
List<SalesChannel> |
The sales channels the product is associated with. Available if the relation `sales_channels` is expanded. |
[optional] |
| createdAt |
OffsetDateTime |
The date with timezone at which the resource was created. |
|
| updatedAt |
OffsetDateTime |
The date with timezone at which the resource was updated. |
|
| deletedAt |
OffsetDateTime |
The date with timezone at which the resource was deleted. |
|
| metadata |
Object |
An optional key-value map with additional details |
|