Skip to content

Products

Search published products and inspect details, related items, and reviews.

Fields

idstringUnique identifier of the resource.
namestring
statusstring
pricenumber
slugstringURL-friendly identifier.
urlstring
descriptionstring
productTypestring
See all 32 fields
imageUrlstring
compareAtPricenumber
isAvailableboolean
totalInventoryinteger
brandstring
categorystring
tagsarray<string>
specificationsarray<object>
variantsarray<object>
imagesarray<object>
bundleItemsarray<object>
sizeGuideobject
priceTiersarray<object>
createdAtstring
updatedAtstring
sellerobject
isPreviewboolean
templatestring
sellerOffersarray<object>
modifierGroupsarray<object>Active customizations the buyer fills in before adding the product to the cart, in store order; empty when the product has none.
seoobject
metafieldsarray<object>
brandSlugstring
categoryIdstring

Operations

MethodEndpointOperation
GET/v1/productsSearch products
GET/v1/products/{slug}Get product by slug
GET/v1/products/{productId}/relatedList related products
POST/v1/products/{productId}/reviewsCreate product review
GET/v1/products/{productId}/reviewsList product reviews

Last updated: