Skip to main content

WooCommerce

Read and update a WooCommerce store's orders, products, customers and coupons.

Connect it with: API key. WooCommerce's own documentation: https://woocommerce.github.io/woocommerce-rest-api-docs/#authentication.

What agents can do​

Connect WooCommerce so the agents working your tasks can reach it. With it connected, they can:

  • Look up an order, its items, customer and shipping state when a support task names an order number.
  • List products that are out of stock or missing prices, images or categories, and report them.
  • Change an order's status, add an order note, or update a product's stock or price (needs a Read/Write key).
  • Pull orders and refunds for a date range to build a sales or tax report.

Before you start​

  • A WordPress site with WooCommerce 3.5 or later, served over https and reachable from the internet.
  • A WordPress administrator who can open WooCommerce > Settings > Advanced > REST API.
  • Permalinks set to anything but Plain (Settings > Permalinks): the REST API does not answer with Plain permalinks.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with WooCommerce​

Jaah connects to WooCommerce with an API key, not with a sign-in button.

Connect with an API key​

Find each value first:

  • Store URL: Your WordPress site's https address, the one customers visit, without /wp-admin. If WordPress lives in a folder, include it, such as https://example.com/shop.
  • Consumer key: In WordPress, open WooCommerce > Settings > Advanced > REST API and select Add key. Enter Jaah as the description, pick an administrator or shop manager as the user, set Permissions to Read (or Read/Write if agents must change orders or products) and select Generate API key. Copy the Consumer key, which starts with ck_.
  • Consumer secret: Shown on the same screen as the consumer key, right after Generate API key, and starts with cs_. WooCommerce shows it only once: if you lost it, revoke the key and generate a new one.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the WooCommerce card.
  2. Name the secret and choose who can use it.
  3. Fill in Store URL, Consumer key, Consumer secret.
  4. Select Save. Jaah tests the secret straight away (see Test the connection).

Jaah encrypts what you type and never shows it again — not to you, and not to an admin.

Use your own OAuth app​

Not used: Jaah connects to WooCommerce with an API key, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah calls WooCommerce's API once (GET <Store URL>/wp-json/wc/v3/data/currencies/current) with the stored values, and shows who it answered as, or which value WooCommerce refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A key connection hands the agent its fields: store_url, consumer_key, consumer_secret.

Tell the agent in your task description which secret to use, for example “use the WooCommerce secret org/woocommerce”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at WooCommerce once the test passes. Steps: Replace or delete a secret.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at WooCommerce's side too, revoke or delete the key at WooCommerce.

Limitations​

  • Agents act as the WordPress user the key was created for: they can do only what that user can, and the key stops working if the user is deleted.
  • A Read key cannot change anything; agents get 401 on every write.
  • Hosts that cache or firewall /wp-json (some security plugins do) can block agents even when Test passes.
  • Agents can do only what the connected WooCommerce account allows.

Troubleshooting​

Test says WooCommerce rejected the consumer secret (401)

The key was revoked, its user was deleted or lost the manage WooCommerce right, or the pair was mistyped. Generate a new key in WooCommerce > Settings > Advanced > REST API and select Replace.

Test fails with 401 and the key is right

The host strips the Authorization header before WordPress sees it (common with FastCGI). Ask the host to pass it through, or add SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1 to the site's .htaccess.

Test fails with 404 or says WooCommerce answered, but not with an API response

Permalinks are set to Plain, or Store URL is not the site root. Choose Post name in Settings > Permalinks and check Store URL has no /wp-admin.

Still stuck? Select Test and read the result: it names the value WooCommerce refused and the status it answered.

FAQ​

Read or Read/Write?

Read when agents only report or answer questions; Read/Write when tasks must change orders, products or coupons.

Does Test change anything in my store?

No. It reads the store's currency and nothing else.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one WooCommerce account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.