Products are an essential part of the ecommerce system. Here's a detailed listing of the product entity at YouCan.
| Attribute Name | Type | Description |
|---|---|---|
| id | string | Identifier (UUID) |
| name | string | Product name |
| slug | string | URL slug |
| public_url | string | Full public URL of the product on the storefront |
| thumbnail | string, null | URL of the product thumbnail image |
| description | string, null | Product full description |
| price | float | Product price (in store currency) |
| compare_at_price | float, null | Original price before discount (in store currency) |
| cost_price | float, null | Cost price for profit calculation (in store currency) |
| currency | string | Store currency code |
| visibility | bool | Whether the product is visible on the storefront |
| has_variants | bool | Whether the product has multiple variants |
| variants_count | int | Number of variants (minimum 1 — a default variant is always created) |
| variant_options | array | List of variant option types (e.g. size, color) |
| inventory | int | Total inventory across all variants |
| track_inventory | bool | Whether inventory tracking is enabled |
| you_save_amount | float | Amount saved compared to compare_at_price |
| created_at | string | Creation date (ISO 8601, store timezone) |
| updated_at | string | Last update date (ISO 8601, store timezone) |
| deleted_at | string, null | Deletion date (ISO 8601), null if not deleted |
| meta | object | SEO attributes |
| images | array | Product images (default include) |
| variants | array | Product variants (available include) |
| categories | array | Assigned categories (available include) |
| vendors | array | Assigned vendors/tags (available include) |
Meta
| Attribute Name | Type | Description |
|---|---|---|
| title | string, null | Meta title |
| description | string, null | Meta description |
| images | array | Meta 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.