Skip to content

Products are an essential part of the ecommerce system. Here's a detailed listing of the product entity at YouCan.

Attribute NameTypeDescription
idstringIdentifier (UUID)
namestringProduct name
slugstringURL slug
public_urlstringFull public URL of the product on the storefront
thumbnailstring, nullURL of the product thumbnail image
descriptionstring, nullProduct full description
pricefloatProduct price (in store currency)
compare_at_pricefloat, nullOriginal price before discount (in store currency)
cost_pricefloat, nullCost price for profit calculation (in store currency)
currencystringStore currency code
visibilityboolWhether the product is visible on the storefront
has_variantsboolWhether the product has multiple variants
variants_countintNumber of variants (minimum 1 — a default variant is always created)
variant_optionsarrayList of variant option types (e.g. size, color)
inventoryintTotal inventory across all variants
track_inventoryboolWhether inventory tracking is enabled
you_save_amountfloatAmount saved compared to compare_at_price
created_atstringCreation date (ISO 8601, store timezone)
updated_atstringLast update date (ISO 8601, store timezone)
deleted_atstring, nullDeletion date (ISO 8601), null if not deleted
metaobjectSEO attributes
imagesarrayProduct images (default include)
variantsarrayProduct variants (available include)
categoriesarrayAssigned categories (available include)
vendorsarrayAssigned vendors/tags (available include)

Meta

Attribute NameTypeDescription
titlestring, nullMeta title
descriptionstring, nullMeta description
imagesarrayMeta images

Images

Array of product image objects. Included by default.

Variants

Array of product variant objects. Use ?include=variants to include.

Categories

Array of category objects assigned to this product. Use ?include=categories to include.

Vendors

Array of vendor/tag objects assigned to this product. Use ?include=vendors to include.