About the Wix Stores Catalog V3

The Wix Stores Catalog V3 is a comprehensive suite of APIs that revolutionizes how developers manage and interact with Wix Stores product catalogs. This next-generation catalog system provides a robust, scalable foundation for building sophisticated e-commerce applications with advanced product management capabilities.

Before you begin

It's important to note the following before starting to code:

  • Each site supports either Catalog V1 or Catalog V3, but not both at the same time. Use the Catalog Versioning API to determine the API version of a given site.
  • When you create a new dev site to test your app on, the dev site supports Catalog V3.
  • If your app currently utilizes the Catalog V1 API, there are several important considerations:
    • Catalog V3 will initially be rolled out to new users only.
    • To continue supporting both new and existing users, your app will need to support both Catalog V1 and Catalog V3. You must confirm compatibility in your app's dashboard for Wix users to install your app.
    • Over time, Catalog V3 will fully replace Catalog V1.
    • Learn more about migrating from Catalog V1 to Catalog V3.

Catalog V3 services

Catalog V3 provides a comprehensive suite of specialized services, each designed to handle specific aspects of product catalog management:

Products V3

The core service for managing product information, variants, and basic product operations.

Key capabilities:

  • Product lifecycle management - Create, update, delete, and query products with full variant support.
  • Universal variants - Every product has at least one variant. Products without options have a single "default variant" with an empty choices array.
  • Advanced variant handling - Manage complex product variations with options, choices, pricing, and inventory at the variant level.
  • Media management - Associate images, videos, and other media with products and product option choices.
  • Bulk operations - Efficiently manage large product catalogs with bulk create, update, and delete operations.
  • Search and filtering - Powerful query capabilities with flexible filtering and sorting.

Note: When creating products with inline options or modifiers (without referencing existing customization IDs), new standalone Customization entities are automatically created. These can then be reused across other products.

Use Cases: Product catalog management, inventory synchronization, product import/export workflows, storefront product display

Read-Only Variants V3

A read-only service for querying product variants with enhanced search capabilities.

Key capabilities:

  • Variant-centric queries - Query variants directly rather than as nested objects within products.
  • Advanced pagination - Cursor-based pagination supporting up to 1,000 variants per request.
  • Free-text search - Search variants by product name.
  • Aggregation support - Get faceted search results for building advanced filtering UIs.

Note: This API operates on an eventually consistent model. Changes made through the Products API synchronize to this service over time.

Use Cases: Variant-focused inventory management, building variant search interfaces, syncing variant data with external systems

Inventory Items V3

Dedicated service for sophisticated inventory tracking and stock management.

Key capabilities:

  • Per-variant, per-location tracking - Each inventory item represents a specific variant at a specific location, enabling granular inventory control.
  • Real-time stock tracking - Monitor inventory levels with automatic updates and availability calculations.
  • Preorder management - Configure preorder settings per inventory item, allowing different preorder rules for each variant-location combination.
  • Bulk inventory operations - Efficiently update inventory across large product catalogs.

Note: The Create Product endpoint does not automatically create inventory items. Use Create Product With Inventory to create both in a single call, or create inventory items separately using this API.

Use Cases: Warehouse management, dropshipping workflows, multi-location retail, inventory forecasting

Customizations V3

Enables rich product personalization and customization workflows. Customizations can be options (which create variants and affect inventory) or modifiers (which collect additional information without creating variants).

Key capabilities:

  • Options - Create product variations with different SKUs, prices, and inventory tracking. Each combination of option choices creates a variant.
  • Modifiers - Allow customers to customize products with text and selection choices without affecting variants or inventory.
  • Flexible input types - Support text choices, color swatches, and free-text inputs.
  • Reusable customizations - Create a bank of customizations that can be assigned to multiple products.

Note: Options can't be deleted while assigned to any product because they affect variants. Modifiers can be deleted freely and are automatically removed from assigned products.

Use Cases: Print-on-demand products, personalized gifts, custom apparel, product size and color variations

Info Sections V3

Manages additional product information sections for enhanced product descriptions and specifications.

Key capabilities:

  • Rich content sections - Create detailed product information with titles and descriptions.
  • Reusable content blocks - Share common information across multiple products using unique names.
  • Get or create - Retrieve an existing info section by unique name or create a new one if it doesn't exist.

Note: When an info section is deleted, it is automatically removed from all products that reference it.

Use Cases: Technical specifications, size charts, care instructions, warranty information, detailed product descriptions

Brands V3

Comprehensive brand management system for organizing products by manufacturer or brand identity.

Key capabilities:

  • Brand profiles - Create and manage brand information.
  • Brand associations - Link products to brands for organization and filtering.
  • Get or create - Retrieve an existing brand by name or create a new one if it doesn't exist.

Note: When a brand is deleted, it is automatically removed from all products that reference it.

Use Cases: Multi-brand retail, brand catalog organization, brand-based marketing campaigns

Ribbons V3

Flexible system for product badges, labels, and promotional highlighting.

Key capabilities:

  • Promotional badges - Create "Sale", "New", "Featured", and custom promotional labels.
  • Visual customization - Control ribbon appearance with text and colors.
  • Get or create - Retrieve an existing ribbon by name or create a new one if it doesn't exist.

Note: When a ribbon is deleted, it is automatically removed from all products that reference it.

Use Cases: Promotional campaigns, seasonal sales, new product launches, product highlighting

Stores Locations V3

A read-only API that provides access to inventory locations for Wix Stores.

Key capabilities:

  • Location data access - Query store locations, warehouses, and fulfillment centers.
  • Location-based inventory - Use location IDs to track inventory levels specific to each location via the Inventory Items API.
  • Default location handling - Every store has a default location that is automatically created.

Note: This is a read-only API. To create or update locations, use the Wix Locations API and include "INVENTORY" in the locationTypes array. Locations configured for inventory will automatically appear in the Stores Locations API.

Use Cases: Multi-location retail, regional inventory management, local delivery services, pickup locations

Categories

External service providing comprehensive1 category management that integrates seamlessly with Catalog V3.

Key capabilities:

  • Hierarchical categories - Create nested category structures with unlimited depth.
  • Category relationships - Manage parent-child relationships and category associations.
  • Category metadata - Add descriptions, images, and SEO data to categories.
  • Multi-category assignment - Assign products to multiple categories simultaneously.
  • Category-based navigation - Enable structured browsing and filtering

Use Cases: Product organization, storefront navigation, catalog browsing, taxonomic product classification

Questions?

Reach out to us via our Discord channel, or open a ticket with WixBot.

Did this help?