Skip to main content

WooCommerce Integration

Overview

WooCommerce integration is implemented through REST APIs, providing complete three-way synchronization of products, orders, and inventory. Unlike Shopify’s OAuth authorization, WooCommerce requires the merchant to provide API keys to establish a connection.

API Endpoints

ORBEXA provides the following endpoints for WooCommerce integration (implemented via woocommerceRouter.ts):

Connection Management

EndpointMethodFunction
/api/integrations/woocommerce/connectPOSTConnect a WooCommerce store
/api/integrations/woocommerce/testPOSTTest whether the connection is working

Data Sync

EndpointMethodFunction
/api/integrations/woocommerce/sync/productsPOSTSync product data
/api/integrations/woocommerce/sync/ordersPOSTSync order data
/api/integrations/woocommerce/sync/inventoryPOSTSync inventory data

Webhook Management

EndpointMethodFunction
/api/integrations/woocommerce/webhooks/setupPOSTRegister Webhooks
/api/integrations/woocommerce/webhooks/handlePOSTReceive Webhook events

Connection Flow

Step 1: Generate WooCommerce API Keys

The merchant creates API keys in the WooCommerce admin panel (Settings — Advanced — REST API) to obtain a Consumer Key and Consumer Secret.

Step 2: Connect the Store

Submit the following via the /api/integrations/woocommerce/connect endpoint:
  • WooCommerce store URL
  • Consumer Key
  • Consumer Secret

Step 3: Test the Connection

Call the /api/integrations/woocommerce/test endpoint to verify the connection is successful. ORBEXA will attempt to access the WooCommerce REST API to confirm the credentials are valid.

Step 4: Sync Data

After a successful connection, call the three sync endpoints to pull product, order, and inventory data respectively.

Three-Way Sync

Product Sync

  • Pulls all product data from WooCommerce
  • Includes name, description, price, images, variants, and categories
  • Enters the AI Refinery Pipeline for automatic cleaning
  • Synced to all protocol endpoints

Order Sync

  • Syncs WooCommerce orders to ORBEXA
  • Supports ACP commerce.order_status queries
  • Order status changes are reflected in real time

Inventory Sync

  • Syncs inventory quantities in real time
  • Inventory queries across UCP/ACP/MCP endpoints always reflect the latest state
  • AI agents receive accurate information when inventory is low

Webhook Configuration

Use the /api/integrations/woocommerce/webhooks/setup endpoint to register all Webhooks with a single call. Once registered, WooCommerce automatically notifies ORBEXA when the following events occur:
  • Product created/updated/deleted
  • Order created/updated
  • Inventory changes
All Webhook events are processed through the unified /api/integrations/woocommerce/webhooks/handle endpoint.

Platform-Side Rate Limiting

ORBEXA limits calls to the WooCommerce API to 5 requests/second, ensuring it does not exceed the WooCommerce server’s capacity. This is a platform-side rate limit and does not affect AI agent access to ORBEXA endpoints.

Comparison with Shopify Integration

FeatureShopifyWooCommerce
Authorization methodAutomatic OAuthManual API key configuration
Initial setupZero codeRequires generating API keys
WebhooksAutomatically registeredRegistered via setup endpoint
Platform rate limit2 req/s5 req/s
Data syncAuto-triggeredManual or Webhook-triggered

Summary

WooCommerce integration provides complete three-way product/order/inventory sync, with 7 API endpoints covering the full flow of connection, synchronization, and Webhooks. Once configured, data flows automatically into ORBEXA’s protocol endpoint stack.
Next chapter: WordPress Plugin Integration — One-click connection, automatic merchant account and API key creation