Skip to content

Products

Create and update products, relationships, files, and catalog imports.

States

activeFor sale.
outOfStockFor sale, out of units.
draftDraft. Created this way when status is omitted.
inactiveNot for sale.
discontinuedNot for sale.
archivedHidden from lists.

Fields

idstringUnique identifier of the resource.
statusenumPublication status; only active and outOfStock products can be sold.draft · active · inactive · outOfStock · discontinued · archived
skustringStock keeping unit (SKU).
namestringDisplay name of the product.
typeenumKind of product: product, service or bundle.product · service · bundle
currencystringThree-letter currency code of the prices, such as PEN.
pricenumberLowest price among active variants, in the store currency.
versioninteger
See all 65 fields
isInternalSellerbooleanWhether the sale belongs to the store's internal seller.
sellerApprovalPolicyenumHow third-party seller products are moderated: manualReview or autoApprove; null for the internal seller.manualReview · autoApprove ·
reviewRequestedboolean
descriptionstringFull product description.
slugstringURL-friendly identifier.
urlstringStorefront path of the product, from customUrl or the store URL pattern.
customUrlstringCustom storefront path; null when the store URL pattern applies.
templatestringStorefront template assigned to this product; null uses the default template.
summarystringShort product summary; null when not set.
conditionenumItem condition: new, used or refurbished.new · used · refurbished
discountPercentagenumberCurrently always null; compute it from price and compareAtPrice.
taxRatenumberFallback tax rate in percent when no regional rate applies; defaults to 0.
brandobjectBrand of the product; null when none.
variantsarray<object>Variants of the product, excluding deleted ones.
compareAtPricenumberCompare-at price of the lowest-priced active variant; null when none.
costPricenumberCost of the default variant in the store currency; null when not set.
totalOnHandintegerUnits on hand across active variants.
availableintegerUnits available to sell across active variants.
committedintegerUnits reserved for unfulfilled orders across active variants.
totalVariantsintegerNumber of variants, excluding deleted ones.
activeVariantsintegerNumber of variants with active status.
vendorstringVendor or manufacturer name; null when not set.
tagsarray<string>Free-form labels attached to the product.
specificationsarray<object>Product specifications with their values.
imagesarray<object>Product images and videos, sorted by order.
categoryobjectCategory of the product; null when none.
bundleItemsarray<object>Components of a bundle; empty for other product types.
moderationReasonstringReviewer's reason for rejecting or requesting changes to a seller product; null otherwise.
metaTitlestringSEO title; null when not set.
metaDescriptionstringSEO description; null when not set.
metaKeywordsarray<string>SEO keywords; null when not set.
featuredUntilstringEnd of the featured period; currently never set, so always null.
isFeaturedbooleanWhether the product is marked as featured.
minOrderQuantityintegerMinimum quantity per order.
maxOrderQuantityintegerMaximum quantity per order; null means no limit.
isDigitalbooleanWhether the product is digital and needs no shipping.
hasVariantsbooleanWhether the product has more than one variant.
hasOptionsbooleanWhether any variant uses options such as size or color.
hasModifiersbooleanWhether the product has at least one customization assigned.
hasActivitybooleanWhether any activity has been recorded for the product.
hasPriceListsbooleanWhether the product belongs to at least one price list.
hasReviewsbooleanWhether the product has at least one approved review.
hasSizeGuidebooleanWhether an active size guide applies, directly or through its category.
sizeGuideobjectAlways null here; use the product size-guide endpoint instead.
viewsintegerProduct page views; not tracked yet, so always 0.
salesCountnumberUnits sold in confirmed orders, net of returns and refunds.
reviewsCountintegerNumber of approved reviews.
collectionsarray<object>Collections that include the product.
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
lastActivityOnstringWhen activity was last recorded for the product, in UTC; null if never.
operationIdstring
storeIdstringID of the store.
sellerIdstringThe seller of the sale. The store's own products use its internal seller.
packageIdstringID of the default shipping package; null when none.
shippingProfileIdstringID of the assigned shipping profile; null when none.
modifierGroupIdsarray<string>IDs of the customizations assigned to the product, in store order.

Operations

MethodEndpointOperation
POST/v1/catalog/productsCreate a product
GET/v1/catalog/productsList products
GET/v1/catalog/products/{productId}Get product by ID
GET/v1/catalog/products/countCount products
PATCH/v1/catalog/products/{productId}Update a product
DELETE/v1/catalog/products/{productId}Delete a product
POST/v1/catalog/products/{productId}/reviewsCreate product review
GET/v1/catalog/products/creations/{operationId}Get a completed product creation recorded for the current actor
GET/v1/catalog/products/{productId}/price-listsList product prices

Import & export

MethodEndpointOperation
POST/v1/catalog/products/exportsExport products
POST/v1/catalog/products/importsImport products

Batch

MethodEndpointOperation
POST/v1/catalog/products/batchCreate or update products in a batch
POST/v1/catalog/products/batch/collectionsUpdate product collections in bulk
POST/v1/catalog/products/batch/deleteDelete products in bulk
POST/v1/catalog/products/batch/modifier-groupsAssign customizations in bulk
POST/v1/catalog/products/batch/pricesUpdate prices in bulk
POST/v1/catalog/products/batch/statusUpdate status in bulk
POST/v1/catalog/products/batch/tagsUpdate product tags in bulk

Size Guide

MethodEndpointOperation
GET/v1/catalog/products/{productId}/size-guideGet product size guide
PUT/v1/catalog/products/{productId}/size-guideSet product size guide

Last updated: