Reference · built on requestConnectorCommerce & orders

WooCommerce

Orders, customers, products, and stock from one WooCommerce store through the wc/v3 REST API and signed webhooks.

About

WooCommerce is a commerce plugin for WordPress, published by Automattic. A store exposes its data under /wp-json/wc/v3/ once pretty permalinks are on: orders, order notes, refunds, customers, products and variations, coupons, reports, settings, shipping zones, and tax rates. Store webhooks post JSON to a delivery URL for order, customer, product, and coupon events, signed with X-WC-Webhook-Signature.

An operator on Fibric reads new and changed orders, checks stock_quantity on the products in them, and proposes a status change, an order note, or a refund. You approve each one, and a receipt records what changed, why, and how to reverse it.

This is a reference listing. It documents what Fibric would read from WooCommerce and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Orders with line_items, shipping_lines, customer_note, and meta_data through GET /wp-json/wc/v3/orders
  • Order status: pending, processing, on-hold, completed, cancelled, refunded, failed, or trash
  • Webhook topics order.created, order.updated, order.deleted, and order.restored delivered to your URL
  • Customers with billing and shipping addresses through /wp-json/wc/v3/customers
  • Products and variations with sku, stock_quantity, stock_status, and manage_stock
  • Customer, product, and coupon webhook topics, plus X-WP-Total and X-WP-TotalPages pagination headers

Proposed actions

  • Target capability: propose an order status update with PUT /wp-json/wc/v3/orders/{id}
  • Target capability: propose an order note, optionally flagged customer_note, with POST /orders/{order_id}/notes
  • Target capability: propose a refund with amount, reason, and line_items through POST /orders/{order_id}/refunds
  • Target capability: propose a stock_quantity change on a product or variation

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Answer 'where is my order' from the order itself

    Read the order status and shipping lines, then propose a customer-facing order note with the tracking details.

    With WISMO Deflection, Tracking Sync

  • Catch a duplicate before it ships

    On order.created, compare the billing address and line items with recent orders and propose putting the second one on-hold.

    With Duplicate Order, Order Risk

  • Refund exactly what came back

    When a return is checked in, propose a refund for those line_items with a reason, for approval before it posts.

    With Returns Triage, Refund Policy

  • Keep stock_status true to the shelf

    Compare manage_stock products with warehouse counts and propose stock_quantity corrections before an oversell.

    With Oversell Watch, Safety Stock

Requirements

  • WooCommerce 3.5 or later on WordPress 4.4 or later, with pretty permalinks enabled under Settings > Permalinks
  • A REST API key with Read/Write permission, tied to a WordPress user whose role allows the operations
  • HTTPS on the store; over plain HTTP the API requires OAuth 1.0a one-legged signatures instead
  • One webhook per topic, created with a secret so deliveries can be checked against X-WC-Webhook-Signature
Authentication
A REST API key generated under WooCommerce > Settings > Advanced > REST API, sent as HTTP Basic Auth with the consumer key and consumer secret over HTTPS.

Limits

  • Requests page 10 items by default; set per_page and read X-WP-TotalPages to walk a long order history
  • The API acts with the roles and capabilities of the WordPress user behind the key, so a limited user sees less
  • WooCommerce does not publish REST API rate limits; throughput depends on the WordPress host

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request WooCommerce ↗

Questions and answers

Does WooCommerce send webhooks for order changes?
Yes. A store webhook has a topic such as order.updated, a delivery_url, and a secret. WooCommerce posts the order as JSON and signs each delivery with X-WC-Webhook-Signature, an HMAC SHA256 of the payload using that secret. Topics also exist for customers, products, and coupons.
What permissions does the API key need?
Keys are created under WooCommerce > Settings > Advanced > REST API with Read, Write, or Read/Write access. Proposing status changes, notes, or refunds needs Read/Write. Calls are further limited by the roles and capabilities of the WordPress user the key belongs to.
Which WooCommerce and WordPress versions does the wc/v3 API need?
WooCommerce 3.5 or later and WordPress 4.4 or later. Pretty permalinks must be enabled under Settings > Permalinks; the default permalink setting does not work. HTTPS is recommended so the key can be sent with HTTP Basic Auth instead of OAuth 1.0a signatures.
Ask about WooCommerce

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.