List promocodes
list_promocodesFilter and paginate store promocodes by ACTIVE or INACTIVE status, with partial-coverage reporting when the result list is incomplete.
Instructions
List promocodes of the store filtered by status (paginated). The status filter is required by the API. 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 all pages via auto-pagination, up to 500 items; 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. | |
| status | Yes | Promocode status to include (required). | |
| per_page | No | Items per page, 1-25 (default 25). The live API rejects values above 25 for this endpoint even though the published spec allows 100; values outside the range are clamped. |