Products

Administrative endpoints for products — the catalog records managed by internal management tools and integration systems.

Core Capabilities

1. Product Listing & Filtering

• Retrieve a paginated catalog of products.

• Filter by identifier, SKU, base code, and product type, and order results by one or more fields.

2. Product Lifecycle Management

• Create products of every writable type (Simple, Product Meta, Bundle, Grouped, Miscellaneous, Offer).

• Fully or partially update existing products, subject to product-type transition rules.

• Soft-delete (deactivate) a product while preserving its record.

3. Search Indexing

• Re-index a single product in the search engine so recent catalog changes become searchable immediately.

Product Types

Product endpoints use the following product types. The numeric code is the value sent and returned in requests and responses.

Code	Type	Description
-1	Pre Product	Draft product not yet finalized
0	Simple	Standard product, optionally a variant of a product meta
1	Product Meta	Parent product that groups variants together
2	Bundle	Configurable product built from chapter-based selections
3	Grouped	Collection of related products sold as a set
-2	Pre Miscellaneous	Draft miscellaneous product
4	Miscellaneous	Special product such as a service or fee
5	Offer	Seller-specific product offer in a marketplace

Dynamic Settings & Environment Variables

The behavior of these endpoints is influenced by the following dynamic settings, configured in the management panel. Each is referenced again in the description of the operations it affects.

Key	Type	Default	Effect
LIST_SIMPLE_INSTEAD_OF_META	boolean	false	When enabled, an individual simple variant is exposed as the listable product for its group instead of the parent product meta. Affects the listability computed on create and update for Simple and Product Meta products, and determines which product receives a generated storefront URL. When unset, its value falls back to the corresponding server configuration value, and to false if that is also unset.
LISTABLE_PRODUCT_RULES	array of strings	["image_rule", "is_listable_rule"]	The ordered list of rules that decide which variant becomes the listable product within a group. Affects which sibling variant is chosen as listable on create and update. Available rules are image_rule (has an image), is_listable_rule (already listable), stock_rule (has stock), max_price_rule (highest price), and min_price_rule (lowest price). The list cannot be empty.

Environment variables: No environment variables affect these endpoints. All configurable behavior is controlled through the dynamic settings above.