ProductDTO
A product's data.
id
stringRequiredThe ID of the product.
title
stringRequiredThe title of the product.
is_giftcard
booleanRequiredWhether the product is a gift card.
The status of the product.
The associated product tags.
The associated product variants.
The associated product options.
The associated product images.
handle
null | stringThe handle of the product. The handle can be used to create slug URL paths.
subtitle
null | stringThe subttle of the product.
description
null | stringThe description of the product.
thumbnail
null | stringThe URL of the product's thumbnail.
width
null | numberThe width of the product.
weight
null | numberThe weight of the product.
length
null | numberThe length of the product.
height
null | numberThe height of the product.
origin_country
null | stringThe origin country of the product.
hs_code
null | stringThe HS Code of the product.
mid_code
null | stringThe MID Code of the product.
material
null | stringThe material of the product.
The associated product collection.
collection_id
null | stringThe associated product collection id.
The associated product categories.
The associated product type.
type_id
null | stringThe associated product type id.
discountable
booleanWhether the product can be discounted.
external_id
null | stringThe ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain
a reference to the ID in the integrated service.
created_at
string | DateWhen the product was created.
updated_at
string | DateWhen the product was updated.
deleted_at
string | DateWhen the product was deleted.
metadata
Record<string, unknown>Holds custom data in key-value pairs.
Was this section helpful?