List products
list_productsRetrieve paginated product records for raw catalog-structure dumps. Use when you need explicit product-group data; check coverage envelope and report partial results.
Instructions
List product records (paginated); for export requests, use this for explicit raw product-group or catalog-structure dumps. Ordinary catalog exports use list_variants: a product carries grouping and category data, not a sellable name, SKU, price or stock. format:"csv" defaults to top-level scalar fields (currently id and group_id) and does not flatten variant data. The response carries a machine-readable coverage envelope (coverage, received, total_count, pages_read); coverage:"partial" MUST be reflected in the user-facing answer and forbids claiming the listing is complete.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all | No | Fetch pages via auto-pagination, up to 500 items; inspect coverage and continue with explicit page reads if coverage is partial; ignores page/per_page. | |
| page | No | Page number, starting at 1 (default 1). | |
| fields | No | CSV columns; only valid together with format:"csv". Field names are validated against the item schema of the operation's response — an unknown name fails with the list of allowed fields. Default: every top-level scalar field of the item. | |
| format | No | Output format: "csv" renders the items as RFC 4180 CSV (a leading "# coverage:" comment line, then the header row) instead of JSON — cheaper for wide exports. Default: JSON. | |
| per_page | No | Items per page, 1-100 (default 25). Values outside the range are clamped. |