Coupon Read Tool
coupon-readList or show discount coupons with filtering, sorting and pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for "list". Default 1. | |
| sort | No | Sort fields for "list". Append :asc or :desc for direction (default :asc). Example: ["created_at:desc"]. Available fields: id, code, description, type, discounts, date_expires, new_customers, single_use, single_quantity, duration, is_cart_total, used_count, min_cart_amount, created_at, updated_at, deleted_at, coupons.id, coupons.code, coupons.description, coupons.type, coupons.discounts, coupons.date_expires, coupons.new_customers, coupons.single_use, coupons.single_quantity, coupons.duration, coupons.is_cart_total, coupons.used_count, coupons.min_cart_amount, coupons.created_at, coupons.updated_at, coupons.deleted_at, affiliate. | |
| limit | No | Results per page for "list". Default 20, max 100. | |
| action | Yes | Action to perform. | |
| filters | No | Purity filter object for "list". Keys are field names, values are operator objects. Example: {"status":{"$eq":1}}. Available fields: id, code, description, type, discounts, date_expires, new_customers, single_use, single_quantity, duration, is_cart_total, used_count, min_cart_amount, created_at, updated_at, deleted_at, coupons.id, coupons.code, coupons.description, coupons.type, coupons.discounts, coupons.date_expires, coupons.new_customers, coupons.single_use, coupons.single_quantity, coupons.duration, coupons.is_cart_total, coupons.used_count, coupons.min_cart_amount, coupons.created_at, coupons.updated_at, coupons.deleted_at, affiliate. | |
| coupon_id | No | Coupon id. Required for "show" actions. |