List promocodes
list_promocodesRetrieve store promocodes filtered by ACTIVE or INACTIVE status. Use pagination or auto-fetch up to 500 items to review and manage promotional codes.
Instructions
List promocodes of the store filtered by status (paginated). The status filter is required by the API.
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). | |
| 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. |