Skip to main content

WooCommerce source

Introduction​

The WooCommerce source connector connects to a WooCommerce store and authenticates using WooCommerce REST API credentials (Consumer Key and Consumer Secret).

At this time, the connector supports credential validation but data extraction is still in development. You can use it to verify connectivity and credentials, but syncs will not yet produce data.

Setup​

Prerequisites​

  • A WooCommerce store with the WooCommerce REST API available.
  • WooCommerce REST API credentials:
    • Consumer Key
    • Consumer Secret

Create WooCommerce API credentials​

  1. In your WordPress admin, go to WooCommerce → Settings → Advanced → REST API.
  2. Click Add key.
  3. Choose a user and set Permissions to Read (or Read/Write if you plan to use endpoints that require it later).
  4. Generate the key and copy:
    • Consumer key
    • Consumer secret

Authentication​

This connector authenticates to the WooCommerce REST API using HTTP Basic Auth:

  • Username: consumer_key
  • Password: consumer_secret

During connection testing/login, the connector validates credentials by calling:

  • GET https://<shop_url>/wp-json/wc/v3/products?per_page=1

Configuration​

FieldTypeRequiredDescription
shop_urlstring✅Base URL of your WooCommerce shop. Must be a valid URL and must use HTTPS. You can provide it with or without the scheme (e.g., https://example.com or example.com). Trailing slashes are ignored.
consumer_keystring✅WooCommerce REST API Consumer Key.
consumer_secretstring✅WooCommerce REST API Consumer Secret.

shop_url examples​

Valid:

  • https://store.example.com
  • store.example.com (the connector will treat this as https://store.example.com)

Invalid:

  • http://store.example.com (HTTPS is required)

Streams​

No streams are currently available. Extraction will fail with an “in development” error until the connector’s extraction implementation is released.

Limitations​

  • Extraction not yet supported: the connector currently validates credentials only.
  • Catalog not yet defined: the connector does not yet expose a stream catalog.