Woo Cancel And Restock

woo-cancel-and-restock

Purpose

Cancel one or many WooCommerce orders and automatically restore the stock quantities for all line items. Useful for fraudulent orders, duplicate orders, or bulk cancellations when a product batch is unavailable. Includes dry-run preview listing all affected orders and stock restores.

Prerequisites

• WooCommerce store with REST API enabled
• Consumer Key with Read/Write scope
• Orders must be in a cancellable state (pending, on-hold, processing)
• 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 | true | Preview without executing | | format | string | no | human | Output format: human or json | | order_ids | array | no | — | Specific order IDs to cancel (if not using filters) | | filter_status | string | no | on-hold | Cancel all orders with this status (if not using order_ids) | | filter_date_before | string | no | — | Only orders before this date (YYYY-MM-DD) | | restock | bool | no | true | Restore stock for cancelled line items | | cancellation_note | string | no | Order cancelled in bulk | Private note added to each cancelled order |

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

Step 3 cancels orders — this is irreversible. Always run with dry_run: true first (the default). Cancellation triggers a customer cancellation email. restock: true returns items to inventory.

Workflow Steps

Step 1 — Resolve order list

If order_ids provided: fetch each via GET /wp-json/wc/v3/orders/{id}.

If using filters:

GET /wp-json/wc/v3/orders
  ?status=&per_page=100&page=1
  [&before=]

Validate each: status must be pending, on-hold, or processing.

Step 2 — Preview or execute

If dry_run: true: list orders, total value, and stock to be restored. Stop.

If dry_run: false and confirmed:

PUT /wp-json/wc/v3/orders/{id}
  Body: { "status": "cancelled" }

Note: WooCommerce handles stock restock automatically when orders are cancelled if woocommerce_manage_stock is enabled. Set restock: true in the request context.

API Endpoints Used

GET  /wp-json/wc/v3/orders        — filter orders
GET  /wp-json/wc/v3/orders/{id}   — fetch specific orders
PUT  /wp-json/wc/v3/orders/{id}   — cancel order

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:                   ║
╚══════════════════════════════════════════╝

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

[N/TOTAL]   →  records | params: =

COMPLETION (human format):

╔══════════════════════════════════════════╗
║  COMPLETE: woo-cancel-and-restock        ║
║  RECORDS PROCESSED:                   ║
║  OUTPUT: stdout                          ║
╚══════════════════════════════════════════╝

COMPLETION (json format):

{
  "skill": "woo-cancel-and-restock",
  "store": "",
  "completed_at": "",
  "records_processed": ,
  "output_file": null,
  "dry_run": 
}

Output Format

Human format: table of order number, customer, total, items restocked, and cancellation note.

Error Handling

| Error | Cause | Resolution | |-------|-------|------------| | 401 Unauthorized | Invalid credentials | Verify consumerkey and consumersecret | | 403 Forbidden | Key lacks Read/Write scope | Regenerate with Read/Write scope | | Invalid status | Order already completed or refunded | Cannot cancel — must refund instead | | 429 Too Many Requests | Rate limit | Wait 2 seconds and retry |

Best Practices

• Always run with dry_run: true first. Cancellations are permanent.
• For completed orders that need reversal, use woo-refund-and-reorder instead.
• Set a meaningful cancellation_note for your records (e.g., "Bulk cancel: product recall batch A").

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.