# PhoenixKitEcommerce v0.1.8 - Table of Contents

> E-commerce module for PhoenixKit — products, categories, cart, checkout

## Modules

- [PhoenixKit.Modules.Shop.Cart](PhoenixKit.Modules.Shop.Cart.md): Compat alias for PhoenixKitEcommerce.Cart.
Used as Ecto schema in queries (from(c in PhoenixKit.Modules.Shop.Cart, ...)).

- [PhoenixKit.Modules.Shop.Web.Plugs.ShopSession](PhoenixKit.Modules.Shop.Web.Plugs.ShopSession.md): Compat alias for PhoenixKitEcommerce.Web.Plugs.ShopSession.
Must be a real Plug so `plug` macro works.

- [PhoenixKit.Modules.Shop.Web.Routes](PhoenixKit.Modules.Shop.Web.Routes.md): Compat alias for PhoenixKitEcommerce.Web.Routes.

- [PhoenixKit.Modules.Shop.Web.UserOrderDetails](PhoenixKit.Modules.Shop.Web.UserOrderDetails.md): Compat alias for PhoenixKitEcommerce.Web.UserOrderDetails.
LiveView — delegates mount, handle_params.

- [PhoenixKit.Modules.Shop.Web.UserOrders](PhoenixKit.Modules.Shop.Web.UserOrders.md): Compat alias for PhoenixKitEcommerce.Web.UserOrders.
LiveView — delegates mount, handle_params, handle_event.

- [PhoenixKitEcommerce](PhoenixKitEcommerce.md): E-commerce Shop Module for PhoenixKit.
- [PhoenixKitEcommerce.Activity](PhoenixKitEcommerce.Activity.md): Thin wrapper around `PhoenixKit.Activity.log/1` for the shop module.
- [PhoenixKitEcommerce.Cart](PhoenixKitEcommerce.Cart.md): Shopping cart schema with support for guest and authenticated users.
- [PhoenixKitEcommerce.CartItem](PhoenixKitEcommerce.CartItem.md): Cart item schema with price snapshot for consistency.
- [PhoenixKitEcommerce.Category](PhoenixKitEcommerce.Category.md): Category schema for product organization.
- [PhoenixKitEcommerce.Errors](PhoenixKitEcommerce.Errors.md): Central mapping from the error atoms returned by the e-commerce module's
context, importers, image services, and web layer to translated
human-readable strings.
- [PhoenixKitEcommerce.Events](PhoenixKitEcommerce.Events.md): PubSub event broadcasting for Shop module.
- [PhoenixKitEcommerce.Gettext](PhoenixKitEcommerce.Gettext.md): Gettext backend for `phoenix_kit_ecommerce`.
- [PhoenixKitEcommerce.Import.CSVAnalyzer](PhoenixKitEcommerce.Import.CSVAnalyzer.md): Analyze Shopify CSV files to extract option metadata.
- [PhoenixKitEcommerce.Import.CSVParser](PhoenixKitEcommerce.Import.CSVParser.md): Parse Shopify CSV and group rows by Handle.
- [PhoenixKitEcommerce.Import.CSVValidator](PhoenixKitEcommerce.Import.CSVValidator.md): Validates CSV files before import processing.
- [PhoenixKitEcommerce.Import.Filter](PhoenixKitEcommerce.Import.Filter.md): Filter products for import based on configurable rules.
- [PhoenixKitEcommerce.Import.FormatDetector](PhoenixKitEcommerce.Import.FormatDetector.md): Auto-detect CSV format from file headers.
- [PhoenixKitEcommerce.Import.ImportFormat](PhoenixKitEcommerce.Import.ImportFormat.md): Behaviour for CSV import format adapters.
- [PhoenixKitEcommerce.Import.OptionBuilder](PhoenixKitEcommerce.Import.OptionBuilder.md): Build option values and price modifiers from Shopify variant rows.
- [PhoenixKitEcommerce.Import.ProductTransformer](PhoenixKitEcommerce.Import.ProductTransformer.md): Transform Shopify CSV rows into PhoenixKit Product format.
- [PhoenixKitEcommerce.Import.PromUaFormat](PhoenixKitEcommerce.Import.PromUaFormat.md): Prom.ua CSV format adapter implementing `ImportFormat` behaviour.
- [PhoenixKitEcommerce.Import.ShopifyCSV](PhoenixKitEcommerce.Import.ShopifyCSV.md): Main orchestrator for Shopify CSV import.
- [PhoenixKitEcommerce.Import.ShopifyFormat](PhoenixKitEcommerce.Import.ShopifyFormat.md): Shopify CSV format adapter implementing `ImportFormat` behaviour.
- [PhoenixKitEcommerce.ImportConfig](PhoenixKitEcommerce.ImportConfig.md): ImportConfig schema for configurable CSV import filtering.
- [PhoenixKitEcommerce.ImportLog](PhoenixKitEcommerce.ImportLog.md): ImportLog schema for tracking CSV import history.
- [PhoenixKitEcommerce.OptionTypes](PhoenixKitEcommerce.OptionTypes.md): Supported option types for product options.
- [PhoenixKitEcommerce.Options](PhoenixKitEcommerce.Options.md): Context for managing product options.
- [PhoenixKitEcommerce.Options.MetadataValidator](PhoenixKitEcommerce.Options.MetadataValidator.md): Validates and normalizes product metadata for options and pricing.
- [PhoenixKitEcommerce.Product](PhoenixKitEcommerce.Product.md): Product schema for e-commerce shop.
- [PhoenixKitEcommerce.Services.ImageDownloader](PhoenixKitEcommerce.Services.ImageDownloader.md): Service for downloading images from external URLs and storing them in the Storage module.
- [PhoenixKitEcommerce.Services.ImageMigration](PhoenixKitEcommerce.Services.ImageMigration.md): Orchestrates batch migration of product images from external URLs to Storage module.
- [PhoenixKitEcommerce.ShippingMethod](PhoenixKitEcommerce.ShippingMethod.md): Shipping method schema for E-Commerce module.
- [PhoenixKitEcommerce.ShopConfig](PhoenixKitEcommerce.ShopConfig.md): Shop configuration storage schema (key-value JSONB).
- [PhoenixKitEcommerce.SlugResolver](PhoenixKitEcommerce.SlugResolver.md): Resolves URL slugs to Products and Categories with language awareness.
- [PhoenixKitEcommerce.Translations](PhoenixKitEcommerce.Translations.md): Localized fields helper for Shop module.
- [PhoenixKitEcommerce.Web](PhoenixKitEcommerce.Web.md): Provides common imports and setup for Shop module LiveViews.
- [PhoenixKitEcommerce.Web.CartPage](PhoenixKitEcommerce.Web.CartPage.md): Public cart page LiveView for E-Commerce module.
- [PhoenixKitEcommerce.Web.Carts](PhoenixKitEcommerce.Web.Carts.md): Carts admin list LiveView for E-Commerce module.

- [PhoenixKitEcommerce.Web.CatalogCategory](PhoenixKitEcommerce.Web.CatalogCategory.md): Public shop category page.
Shows products filtered by category.

- [PhoenixKitEcommerce.Web.CatalogProduct](PhoenixKitEcommerce.Web.CatalogProduct.md): Public product detail page with add-to-cart functionality.
- [PhoenixKitEcommerce.Web.Categories](PhoenixKitEcommerce.Web.Categories.md): Categories list LiveView for Shop module.
- [PhoenixKitEcommerce.Web.CategoryForm](PhoenixKitEcommerce.Web.CategoryForm.md): Category create/edit form LiveView for Shop module.
- [PhoenixKitEcommerce.Web.CheckoutComplete](PhoenixKitEcommerce.Web.CheckoutComplete.md): Order confirmation page after successful checkout.

- [PhoenixKitEcommerce.Web.CheckoutPage](PhoenixKitEcommerce.Web.CheckoutPage.md): Checkout page LiveView for converting cart to order.
Supports both logged-in users (with billing profiles) and guest checkout.
- [PhoenixKitEcommerce.Web.Components.CatalogSidebar](PhoenixKitEcommerce.Web.Components.CatalogSidebar.md): Reusable sidebar component for the shop storefront.
- [PhoenixKitEcommerce.Web.Components.FilterHelpers](PhoenixKitEcommerce.Web.Components.FilterHelpers.md): Shared helpers for storefront filter state management.
- [PhoenixKitEcommerce.Web.Components.ShopCards](PhoenixKitEcommerce.Web.Components.ShopCards.md): Reusable product display components for the shop storefront.
- [PhoenixKitEcommerce.Web.Components.ShopLayouts](PhoenixKitEcommerce.Web.Components.ShopLayouts.md): Shared layout components for the shop storefront public pages.
- [PhoenixKitEcommerce.Web.Components.TranslationTabs](PhoenixKitEcommerce.Web.Components.TranslationTabs.md): Translation tabs component for Shop module forms.
- [PhoenixKitEcommerce.Web.Dashboard](PhoenixKitEcommerce.Web.Dashboard.md): E-Commerce module dashboard LiveView.
- [PhoenixKitEcommerce.Web.Helpers](PhoenixKitEcommerce.Web.Helpers.md): Shared helper functions for Shop public LiveViews.
- [PhoenixKitEcommerce.Web.ImportConfigs](PhoenixKitEcommerce.Web.ImportConfigs.md): Import configurations management LiveView.
- [PhoenixKitEcommerce.Web.ImportShow](PhoenixKitEcommerce.Web.ImportShow.md): LiveView for displaying import details.
- [PhoenixKitEcommerce.Web.Imports](PhoenixKitEcommerce.Web.Imports.md): Admin LiveView for managing CSV product imports.
- [PhoenixKitEcommerce.Web.OptionState](PhoenixKitEcommerce.Web.OptionState.md): Encapsulates option-related state for product form.
- [PhoenixKitEcommerce.Web.OptionsSettings](PhoenixKitEcommerce.Web.OptionsSettings.md): Global product options settings LiveView.
- [PhoenixKitEcommerce.Web.Plugs.ShopSession](PhoenixKitEcommerce.Web.Plugs.ShopSession.md): Plug that ensures a persistent shop session ID exists.
- [PhoenixKitEcommerce.Web.ProductDetail](PhoenixKitEcommerce.Web.ProductDetail.md): Product detail view LiveView for Shop module.

- [PhoenixKitEcommerce.Web.ProductForm](PhoenixKitEcommerce.Web.ProductForm.md): Product create/edit form LiveView for Shop module.
- [PhoenixKitEcommerce.Web.Products](PhoenixKitEcommerce.Web.Products.md): Products list LiveView for Shop module.

- [PhoenixKitEcommerce.Web.Routes](PhoenixKitEcommerce.Web.Routes.md): Shop module routes.
- [PhoenixKitEcommerce.Web.Settings](PhoenixKitEcommerce.Web.Settings.md): E-Commerce module settings LiveView.
- [PhoenixKitEcommerce.Web.ShippingMethodForm](PhoenixKitEcommerce.Web.ShippingMethodForm.md): Shipping method create/edit form LiveView.

- [PhoenixKitEcommerce.Web.ShippingMethods](PhoenixKitEcommerce.Web.ShippingMethods.md): Shipping methods list LiveView for E-Commerce module admin.

- [PhoenixKitEcommerce.Web.ShopCatalog](PhoenixKitEcommerce.Web.ShopCatalog.md): Public shop catalog main page.
Shows categories and featured/active products.

- [PhoenixKitEcommerce.Web.TestShop](PhoenixKitEcommerce.Web.TestShop.md): Test module for verifying Shop functionality:
- Specification price modifiers (fixed and percent)
- Storage image integration
- Price calculation

- [PhoenixKitEcommerce.Web.UserOrderDetails](PhoenixKitEcommerce.Web.UserOrderDetails.md): LiveView for displaying order details to the order owner.
- [PhoenixKitEcommerce.Web.UserOrders](PhoenixKitEcommerce.Web.UserOrders.md): LiveView for displaying user's shop orders.
- [PhoenixKitEcommerce.Workers.CSVImportWorker](PhoenixKitEcommerce.Workers.CSVImportWorker.md): Oban worker for background CSV import.
- [PhoenixKitEcommerce.Workers.ImageMigrationWorker](PhoenixKitEcommerce.Workers.ImageMigrationWorker.md): Oban worker for migrating product images from external URLs to Storage module.
- [PromUaCSV](PromUaCSV.md)
- [ShopifyCSV](ShopifyCSV.md)
- [ValidatorCSV](ValidatorCSV.md)

## Mix Tasks

- [mix phoenix_kit_ecommerce.deduplicate_products](Mix.Tasks.PhoenixKitEcommerce.DeduplicateProducts.md): Finds and merges duplicate products by slug.
- [mix phoenix_kit_ecommerce.install](Mix.Tasks.PhoenixKitEcommerce.Install.md): Installs PhoenixKit E-commerce module into parent application.