WooCommerce Setup

Generate WooCommerce REST API Keys

WooSync authenticates to your WooCommerce store using the built-in REST API credentials.

  1. In your WordPress admin, go to WooCommerce > Settings > Advanced > REST API
  2. Click Add Key
  3. Set a description (e.g., “ERPNext WooSync”)
  4. Set User to an administrator account
  5. Set Permissions to Read/Write
  6. Click Generate API Key
  7. Copy the Consumer Key and Consumer Secret — you’ll need these when creating your Caz Woo Store record. They are shown only once.

Webhook Configuration

WooSync automatically creates the required webhooks in WooCommerce when you test the store connection. The webhooks it creates are:

  • Order Created
  • Order Updated
  • Order Deleted
  • Customer Created
  • Customer Updated
  • Product Created
  • Product Updated

All webhooks point to your ERPNext URL at https://your-erpnext.com/api/method/caz_woosync.api.webhook.handle.

Webhook Secret (Recommended)

Add a Webhook Secret to your Caz Woo Store record before creating webhooks. WooSync will verify the X-WC-Webhook-Signature header on all incoming webhook requests, preventing spoofed payloads.

Firewall / Server Requirements

Your ERPNext server must be reachable from WooCommerce’s hosting IP range for webhooks to work. If your ERPNext is behind a firewall:

  • Open inbound port 443 (HTTPS) from WooCommerce’s server IP
  • Or use the 15-minute polling fallback — webhooks are optional if your server is not publicly accessible

WooCommerce API Version

WooSync uses WooCommerce REST API v3 by default (field: woo_api_version in the store record). This is compatible with WooCommerce 7.0+. Do not change this unless instructed by support.

Was this article helpful?