Woo Coupon Discount Impact

woo-coupon-discount-impact

Purpose

Aggregate the total discount value applied by each coupon code across WooCommerce orders in a specified date range. Quantifies revenue foregone per coupon, order attach rate, and average discount per use. Read-only.

Prerequisites

• WooCommerce store with REST API enabled
• Consumer Key with Read scope
• Minimum WooCommerce version: 3.5.0

Parameters

| Parameter | Type | Required | Default | Description | |-----------|------|----------|---------|-------------| | store_url | string | yes | — | Base URL of the WooCommerce store | | consumer_key | string | yes | — | WooCommerce REST API consumer key (ck_...) | | consumer_secret | string | yes | — | WooCommerce REST API consumer secret (cs_...) | | dry_run | bool | no | false | No effect — read-only skill | | format | string | no | human | Output format: human or json | | date_after | string | yes | — | Start date (YYYY-MM-DD) | | date_before | string | yes | — | End date (YYYY-MM-DD) | | min_uses | int | no | 1 | Only report coupons used at least this many times |

Authentication

WooCommerce uses OAuth 1.0a for HTTP and Basic Auth over HTTPS.

For HTTPS stores (recommended):

Authorization: Basic base64(consumer_key:consumer_secret)

For HTTP stores (development only): Use OAuth 1.0a — include oauthconsumerkey, oauthnonce, oauthsignature, oauthsignaturemethod=HMAC-SHA1, oauthtimestamp, oauthversion=1.0

Never log or output consumerkey or consumersecret values.

See docs/AUTHENTICATION.md for full setup instructions.

Safety

Read-only skill — no mutations are executed. Safe to run at any time.

Workflow Steps

Step 1 — Fetch completed orders in range

GET /wp-json/wc/v3/orders
  ?status=completed&after=T00:00:00Z&before=T23:59:59Z&per_page=100&page=1

For each order, extract coupon_lines[]: code, discount, discount_tax.

Step 2 — Fetch coupon metadata

GET /wp-json/wc/v3/coupons?per_page=100&page=1

Enrich each coupon code with discount_type, amount, usage_count, expiry_date.

Step 3 — Aggregate by coupon code

For each coupon code seen in orders:

• order_count — distinct orders using this code
• total_discount — sum of coupon_lines[].discount
• avg_discount_per_order — totaldiscount / ordercount
• total_discount_tax — sum of coupon_lines[].discount_tax

Step 4 — Sort and export

Sort by total_discount descending. Apply min_uses filter.

API Endpoints Used

GET  /wp-json/wc/v3/orders    — coupon_lines from completed orders
GET  /wp-json/wc/v3/coupons   — coupon metadata (type, configured amount)

Pagination Strategy

WooCommerce REST API uses page/per_page pagination (not cursor-based).

Standard pattern:

page = 1
while True:
  response = GET /endpoint?per_page=100&page=page
  process(response)
  if len(response)                       ║
║  TIME:                     ║
║  MODE:  READ-ONLY                        ║
╚══════════════════════════════════════════╝

PER-OPERATION (emit after each API call batch):

[N/TOTAL]   →  records | params: =

COMPLETION (human format):

╔══════════════════════════════════════════╗
║  COMPLETE: woo-coupon-discount-impact    ║
║  RECORDS PROCESSED:                   ║
║  OUTPUT:                       ║
╚══════════════════════════════════════════╝

COMPLETION (json format):

{
  "skill": "woo-coupon-discount-impact",
  "store": "",
  "completed_at": "",
  "records_processed": ,
  "output_file": "",
  "dry_run": false
}

Output Format

CSV filename: woo-coupon-discount-impact__.csv Columns: coupon_code, discount_type, configured_amount, order_count, total_discount, avg_discount_per_order, total_discount_tax, usage_count_lifetime

Error Handling

| Error | Cause | Resolution | |-------|-------|------------| | 401 Unauthorized | Invalid credentials | Verify consumerkey and consumersecret | | 403 Forbidden | Key lacks Read scope | Regenerate with Read scope | | 429 Too Many Requests | Rate limit | Wait 2 seconds and retry |

Best Practices

• Compare configured_amount to avg_discount_per_order — percentage coupons on high-AOV orders can exceed intended discount budgets.
• Track total_discount as a percentage of gross revenue for the same period to measure overall promotional spend.
• Run monthly to detect coupon codes that are being shared or used beyond their intended audience.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: navarroido
• Source: navarroido/Woocommerce-skill
• License: MIT

Install and usage instructions live in the source repository linked above.