List WooCommerce Coupons
woocommerce_list_couponsRead-onlyIdempotent
Search and list discount coupons in your WooCommerce store with optional filters by code, sort order, and pagination. Returns coupon details including discount type and expiry.
Instructions
Search and list discount coupons defined in the store.
Args:
search (string, optional): match against coupon code
code (string, optional): exact code match
orderby / order: sorting (default date/desc)
page / per_page: pagination (default page=1, per_page=20, max 100)
response_format ('markdown'|'json'): default 'markdown'
Returns: paginated list of coupons with code, amount, discount type, usage count/limit, and expiry.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Filter by exact coupon code | |
| page | No | Page number to retrieve, 1-based (default: 1) | |
| order | No | Sort direction (default: desc) | desc |
| search | No | Search term to match against coupon code | |
| orderby | No | Sort field (default: date) | date |
| per_page | No | Number of results per page, 1-100 (default: 20) | |
| response_format | No | Output format: 'markdown' for human-readable text or 'json' for machine-readable structured data | markdown |