> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/products.md).

# 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 | `["omnishop.products.listable_rules.image_rule", "omnishop.products.listable_rules.is_listable_rule"]` | The ordered list of rules that decide which variant becomes the listable product within a group. Applied on **update** and **delete**, where the listable position is recomputed across the whole variant family; **create** does not run the rules — a newly created variant becomes listable when its group holds no listable product yet. Available rules are `image_rule` (has an active image), `is_listable_rule` (already listable), `stock_rule` (has stock), `all_stock_rule` (has stock in every stock list), `all_variants_have_image_rule` (every active variant of the group has an active image), `max_price_rule` (highest price), and `min_price_rule` (lowest price). `all_variants_have_image_rule` is evaluated for the group as a whole and must be placed as the **first** entry of the list to take effect: if any active variant of the group has no image, the group is left without a listable product, with no fallback to the variants that do have one. Each entry must be the full dotted path, and the list cannot be empty. |

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/admin/products.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
