> 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/product-advanced/list-active-simple-products-with-pricing-and-stock.md). # List active simple products with pricing and stock Returns a paginated list of active simple products enriched with price, stock, currency, main category, and variant attribute values. **Fixed filters applied by the server:** * Only products with `is_active = true` are returned. * Only products with `product_type = simple` (code `0`) are returned. * Results are ordered by `pk` ascending. **Segment-aware pricing and stock:** Pass the optional `segment` query parameter to retrieve prices and stock quantities from the price list and stock list associated with that segment. When `segment` is omitted or does not match a known segment, the product's default price and stock are returned; `price` will be `"0.00"` if the product has no entry on the requested price list. **Filtering:** Use the filter parameters below to narrow the result set. Multiple values can be passed for `pk__in` and `sku__in` as comma-separated lists. ```json {"openapi":"3.1.0","info":{"title":"Admin API","version":"1.0.0"},"tags":[{"name":"Product Advanced","description":"Read-only product list with segment-aware pricing and stock.\n\nRetrieve a lightweight, read-only list of active simple products enriched with segment-specific pricing, stock, and currency. Pass a segment identifier to resolve prices and stock quantities from the price list and stock list associated with that segment."}],"servers":[{"description":"Omnitron Remote Proxy (external access — recommended)","url":"https://{omnitron_url}/api/remote/{channel_id}","variables":{"omnitron_url":{"default":"sandbox.akinon.com","description":"Omnitron server URL (e.g., {omnitron.akinon.com})"},"channel_id":{"default":"1","description":"The channel identifier the remote request is routed through"}}},{"description":"Commerce API Server (internal / direct access only)","url":"https://{commerce_url}/api/v1","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Internal commerce server URL, reachable only from within the Omnitron network"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token credential sent in the Authorization header, in the form: `Token `. Requires a staff (admin) account."}},"parameters":{"page":{"name":"page","in":"query","required":false,"description":"The page number to return.","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"The number of items to return per page.","schema":{"type":"integer","default":10}}},"schemas":{"ProductAdvancedList":{"type":"object","description":"Paginated list of advanced product representations.","required":["count","results"],"properties":{"count":{"type":"integer","description":"Total number of products matching the current filters."},"next":{"type":["string","null"],"format":"uri","description":"The URL of the next page of results, when available."},"previous":{"type":["string","null"],"format":"uri","description":"The URL of the previous page of results, when available."},"results":{"type":"array","description":"The products on the current page.","items":{"$ref":"#/components/schemas/ProductAdvanced"}}}},"ProductAdvanced":{"type":"object","description":"An active simple product with segment-aware price, stock, currency, main category, first image, and variant attribute values.","required":["pk","name","base_code","sku","product_type","is_active","price","currency","stock","variants"],"properties":{"pk":{"type":"integer","description":"Unique product identifier."},"name":{"type":"string","description":"Display name of the product."},"base_code":{"type":"string","description":"Base product code shared across all variants of the same product."},"sku":{"type":"string","description":"Stock Keeping Unit — unique code for this specific variant."},"product_type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}],"description":"Product type code. Always `\"0\"` (simple) for this endpoint; the queryset is pre-filtered to simple products only."},"is_active":{"type":"boolean","description":"Whether the product is active. Always `true` for this endpoint."},"price":{"type":"string","description":"Current selling price as a decimal string.\n\nWhen a `segment` is provided, this is the price from the segment's price list. When the product has no entry on the requested price list, `\"0.00\"` is returned. When no segment is provided, the product's default price is returned."},"currency":{"type":"string","description":"Currency code for `price`.\n\nWhen a `segment` is provided, this is the currency of the segment's price list. When no segment is provided, the product's own `currency_type` is returned."},"stock":{"type":"integer","description":"Available stock quantity.\n\nWhen a `segment` is provided, this is the stock from the segment's stock list. When the product has no entry on the requested stock list, `0` is returned. When no segment is provided, the product's default stock is returned."},"category":{"type":["string","null"],"description":"Name of the product's main category. `null` when no main category is set."},"product_image":{"type":["string","null"],"format":"uri","description":"URL of the product's first image. `null` when the product has no images."},"variants":{"type":"object","description":"Variant attribute values for this product as a flat key/value map, where each key is an attribute name and the value is the product's value for that attribute.\n\nThe keys present depend on the product's attribute set configuration.","additionalProperties":true}}},"ProductType":{"type":"string","description":"The product type. The value is the numeric code as a string.\n* `-1` — Pre Product\n* `0` — Simple\n* `1` — Product Meta\n* `2` — Bundle\n* `3` — Grouped\n* `-2` — Pre Miscellaneous\n* `4` — Miscellaneous\n* `5` — Offer","enum":["-1","0","1","2","3","-2","4","5"]},"Error":{"type":"object","description":"An error response.","properties":{"detail":{"type":"string","description":"A human-readable description of the error."}},"additionalProperties":true}},"responses":{"Unauthorized":{"description":"Authentication credentials were not provided or are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The authenticated user does not have administrator privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/products_advanced/":{"get":{"tags":["Product Advanced"],"operationId":"listProductsAdvanced","summary":"List active simple products with pricing and stock","description":"Returns a paginated list of active simple products enriched with price, stock, currency, main category, and variant attribute values.\n\n**Fixed filters applied by the server:**\n* Only products with `is_active = true` are returned.\n* Only products with `product_type = simple` (code `0`) are returned.\n* Results are ordered by `pk` ascending.\n\n**Segment-aware pricing and stock:**\nPass the optional `segment` query parameter to retrieve prices and stock quantities from the price list and stock list associated with that segment. When `segment` is omitted or does not match a known segment, the product's default price and stock are returned; `price` will be `\"0.00\"` if the product has no entry on the requested price list.\n\n**Filtering:**\nUse the filter parameters below to narrow the result set. Multiple values can be passed for `pk__in` and `sku__in` as comma-separated lists.","parameters":[{"name":"segment","in":"query","required":false,"description":"ID of a segment whose price list and stock list should be used to resolve `price`, `currency`, and `stock` for each product.\n\nWhen omitted, the product's default price list and stock list are used.","schema":{"type":"integer"}},{"name":"id","in":"query","required":false,"description":"Filter by exact product ID.","schema":{"type":"integer"}},{"name":"id__gt","in":"query","required":false,"description":"Filter products whose ID is greater than the given value.","schema":{"type":"integer"}},{"name":"id__gte","in":"query","required":false,"description":"Filter products whose ID is greater than or equal to the given value.","schema":{"type":"integer"}},{"name":"id__lt","in":"query","required":false,"description":"Filter products whose ID is less than the given value.","schema":{"type":"integer"}},{"name":"id__lte","in":"query","required":false,"description":"Filter products whose ID is less than or equal to the given value.","schema":{"type":"integer"}},{"name":"id__in","in":"query","required":false,"description":"Filter by a comma-separated list of product IDs.","schema":{"type":"string"}},{"name":"pk__in","in":"query","required":false,"description":"Filter by a comma-separated list of product IDs. Equivalent to `id__in`.","schema":{"type":"string"}},{"name":"sku","in":"query","required":false,"description":"Filter by exact SKU.","schema":{"type":"string"}},{"name":"sku__exact","in":"query","required":false,"description":"Filter by exact SKU. Equivalent to `sku`.","schema":{"type":"string"}},{"name":"sku__in","in":"query","required":false,"description":"Filter by a comma-separated list of SKUs.","schema":{"type":"string"}},{"name":"base_code","in":"query","required":false,"description":"Filter by exact base code.","schema":{"type":"string"}},{"name":"base_code__exact","in":"query","required":false,"description":"Filter by exact base code. Equivalent to `base_code`.","schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"}],"responses":{"200":{"description":"A paginated list of products.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAdvancedList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}}}} ``` --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://apidocs.akinon.com/commerce-openapis/admin/products/product-advanced/list-active-simple-products-with-pricing-and-stock.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.