product

type Document struct {
	mixin.DocumentSaveLoad `datastore:"-" json:"-"`

	// Special Kind Option
	Kind string `search:",facet"`

	Id_  string
	Slug string
	SKU  string
	UPC  string

	Currency      string
	Price         float64
	ListPrice     float64
	InventoryCost float64

	// Shipping  float64
	Inventory float64

	Weight     float64
	WeightUnit string

	DimensionsLength float64
	DimensionsWidth  float64
	DimensionsHeight float64
	DimensionsUnit   string

	Name              string
	Description       string
	EstimatedDelivery string

	CreatedAt float64
	UpdatedAt float64

	// Facets
	PriceOption         float64 `search:"price,facet"`
	ListPriceOption     float64 `search:"listPrice,facet"`
	InventoryCostOption float64 `search:"inventoryCost,facet"`

	InventoryOption float64 `search:"inventory,facet"`

	WeightOption     float64 `search:"weight,facet"`
	WeightUnitOption string  `search:"weightUnit,facet"`

	DimensionsLengthOption float64 `search:"dimensionsLength,facet"`
	DimensionsWidthOption  float64 `search:"dimensionsWidth,facet"`
	DimensionsHeightOption float64 `search:"dimensionsHeight,facet"`
	DimensionsUnitOption   string  `search:"dimensionsUnit,facet"`

	AvailableOption string `search:"available,facet"`
	HiddenOption    string `search:"hidden,facet"`
	PreorderOption  string `search:"preorder,facet"`
}

type Option struct {
	// Ex. Size
	Name string `json:"name"`
	// Ex. [S, M, L]
	Values []string `json:"values"`
}

type OptionV2 struct {
	// Name is the option name (e.g., "Size", "Color")
	Name string `json:"name"`
	// Values are the available option values (e.g., ["S", "M", "L"])
	Values []string `json:"values"`
}

type PriceRange struct {
	Min currency.Cents `json:"min"`
	Max currency.Cents `json:"max"`
}

type Product struct {
	mixin.BaseModel
	productcachedvalues.ProductCachedValues

	Ref refs.EcommerceRef `json:"ref,omitempty"`

	// Unique human readable id
	Slug string `json:"slug"`
	SKU  string `json:"sku,omitempty"`
	UPC  string `json:"upc,omitempty"`

	// Product Name
	Name string `json:"name"`

	// Product headline
	Headline string `json:"headline" datastore:",noindex"`

	// Product Excerpt
	Excerpt string `json:"excerpt" datastore:",noindex"`

	// Product Description
	Description string `json:"description" datastore:",noindex"`

	// Product Media
	Header Media   `json:"header"`
	Image  Media   `json:"image"`
	Media  []Media `json:"media"`

	// Is the product available
	Available bool `json:"available"`

	// Is product hidden from users
	Hidden bool `json:"hidden"`

	// Range in which product is available. If active, it takes precedent over
	// Available bool.
	Availability Availability `json:"availability"`

	// Is this product for preorder
	Preorder bool `json:"preorder"`

	// Pre-order now or Add to cart
	AddLabel string `json:"addLabel"`

	// List of variants
	Variants  []*variant.Variant `json:"variants" datastore:"-"`
	Variants_ string             `json:"-" datastore:",noindex"`

	// Reference to options used
	Options  []*Option `json:"options" datastore:"-"`
	Options_ string    `json:"-" datastore:",noindex"`

	Reservation Reservation `json:"reservation"`

	// Arbitrary key/value pairs associated with this order
	Metadata  Map    `json:"metadata,omitempty" datastore:"-"`
	Metadata_ string `json:"-" datastore:",noindex"`
}

type ProductQueryV2 struct {
	// contains filtered or unexported fields
}

type ProductStats struct {
	TotalProducts     int            `json:"totalProducts"`
	AvailableProducts int            `json:"availableProducts"`
	HiddenProducts    int            `json:"hiddenProducts"`
	DeletedProducts   int            `json:"deletedProducts"`
	TotalVariants     int            `json:"totalVariants"`
	TotalInventory    int            `json:"totalInventory"`
	TotalSold         int            `json:"totalSold"`
	PriceRange        PriceRange     `json:"priceRange"`
	CollectionCounts  map[string]int `json:"collectionCounts,omitempty"`
	TagCounts         map[string]int `json:"tagCounts,omitempty"`
}

type ProductV2 struct {
	productcachedvalues.ProductCachedValues

	// Core identification
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
	Deleted   bool      `json:"deleted,omitempty"`

	// Organization context
	OrgID     string `json:"orgId"`
	Namespace string `json:"namespace,omitempty"`

	// External references
	Ref refs.EcommerceRef `json:"ref,omitempty"`

	// Human-readable identifiers
	Slug string `json:"slug"`
	SKU  string `json:"sku,omitempty"`
	UPC  string `json:"upc,omitempty"`

	// Product content
	Name        string `json:"name"`
	Headline    string `json:"headline,omitempty"`
	Excerpt     string `json:"excerpt,omitempty"`
	Description string `json:"description,omitempty"`

	// Media assets
	Header Media   `json:"header,omitempty"`
	Image  Media   `json:"image,omitempty"`
	Media  []Media `json:"media,omitempty"`

	// Availability
	Available    bool         `json:"available"`
	Hidden       bool         `json:"hidden"`
	Availability Availability `json:"availability,omitempty"`
	Preorder     bool         `json:"preorder"`
	AddLabel     string       `json:"addLabel,omitempty"`

	// Variants and options
	Variants []*VariantV2 `json:"variants"`
	Options  []*OptionV2  `json:"options"`

	// Reservation state
	Reservation ReservationV2 `json:"reservation,omitempty"`

	// Flexible metadata (stored as JSON)
	Metadata Map `json:"metadata,omitempty"`

	// AI/ML fields
	EmbeddingVersion string    `json:"embeddingVersion,omitempty"`
	EmbeddingUpdated time.Time `json:"embeddingUpdated,omitempty"`

	// Collections and categories
	CollectionIDs []string `json:"collectionIds,omitempty"`
	Tags          []string `json:"tags,omitempty"`
	Categories    []string `json:"categories,omitempty"`

	// SEO fields
	SEOTitle       string `json:"seoTitle,omitempty"`
	SEODescription string `json:"seoDescription,omitempty"`
	SEOKeywords    string `json:"seoKeywords,omitempty"`
	// contains filtered or unexported fields
}

type Reservation struct {
	// Is the product reservable?
	IsReservable bool `json:"isReservable"`

	// Set to true if being reserved
	IsBeingReserved bool `json:"isBeingReserved"`

	// Usually initials of reserver
	ReservedBy string `json:"reservedBy"`

	// OrderID of Reservation
	OrderId string `json:"orderId"`

	// When was the product reserved
	ReservedAt time.Time `json:"ReservedAt"`
}

type ReservationV2 struct {
	// IsReservable indicates if the product can be reserved
	IsReservable bool `json:"isReservable"`
	// IsBeingReserved indicates if currently reserved
	IsBeingReserved bool `json:"isBeingReserved"`
	// ReservedBy is usually the initials or ID of the reserver
	ReservedBy string `json:"reservedBy,omitempty"`
	// OrderId is the order ID associated with the reservation
	OrderId string `json:"orderId,omitempty"`
	// ReservedAt is when the product was reserved
	ReservedAt time.Time `json:"reservedAt,omitempty"`
}

type SearchV2Options struct {
	OrgID       string
	Query       string   // Text search query
	Collections []string // Filter by collection IDs
	Tags        []string // Filter by tags
	Categories  []string // Filter by categories
	MinPrice    currency.Cents
	MaxPrice    currency.Cents
	Available   *bool
	Hidden      *bool
	Limit       int
	Offset      int
	SortBy      string // Field to sort by
	SortDesc    bool   // Sort descending
}

type VariantOption struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type VariantV2 struct {
	// ID is the unique variant identifier
	ID string `json:"id"`
	// ProductId links back to the parent product
	ProductId string `json:"productId"`
	// SKU is the stock keeping unit
	SKU string `json:"sku"`
	// UPC is the universal product code
	UPC string `json:"upc,omitempty"`
	// Name is the variant name
	Name string `json:"name"`
	// Price in cents
	Price currency.Cents `json:"price"`
	// ListPrice is the original/list price
	ListPrice currency.Cents `json:"listPrice,omitempty"`
	// Available indicates if this variant is available for purchase
	Available bool `json:"available"`
	// Inventory count
	Inventory int `json:"inventory"`
	// Sold count
	Sold int `json:"sold"`
	// Options are the selected option values for this variant
	Options []VariantOption `json:"options"`
	// Media for this variant
	Header Media   `json:"header,omitempty"`
	Image  Media   `json:"image,omitempty"`
	Media  []Media `json:"media,omitempty"`
	// Weight for shipping calculations
	Weight WeightV2 `json:"weight,omitempty"`
}

type WeightV2 struct {
	Value float64  `json:"value"`
	Unit  MassUnit `json:"unit"`
}