woocommerce

# WooCommerce Access the WooCommerce REST API with managed OAuth authentication. Manage products, orders, customers, coupons, shipping, taxes, and more for e-commerce operations. ## Quick Start ```bash # List products curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products" -H "Authorization: Bearer $MATON_API_KEY" ``` ## Base URL ``` https://gateway.maton.ai/woocommerce/{native-api-path} ``` Replace `{native-api-path}` with the actual WooCommerce API endpoint path. The gateway proxies requests to your WooCommerce store and automatically handles authentication. ## Authentication All requests require the Maton API key in the Authorization header: ``` Authorization: Bearer $MATON_API_KEY ``` **Environment Variable:** Set your API key as `MATON_API_KEY`: ```bash export MATON_API_KEY="YOUR_API_KEY" ``` ### Getting Your API Key 1. Sign in or create an account at [maton.ai](https://maton.ai) 2. Go to [maton.ai/settings](https://maton.ai/settings) 3. Copy your API key ## Connection Management Manage your WooCommerce OAuth connections at `https://ctrl.maton.ai`. ### List Connections ```bash curl -s -X GET "https://ctrl.maton.ai/connections?app=woocommerce&status=ACTIVE" -H "Authorization: Bearer $MATON_API_KEY" ``` ### Create Connection ```bash curl -s -X POST "https://ctrl.maton.ai/connections" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"app": "woocommerce"}' ``` ### Get Connection ```bash curl -s -X GET "https://ctrl.maton.ai/connections/{connection_id}" -H "Authorization: Bearer $MATON_API_KEY" ``` **Response:** ```json { "connection": { "connection_id": "21fd90f9-5935-43cd-b6c8-bde9d915ca80", "status": "ACTIVE", "creation_time": "2025-12-08T07:20:53.488460Z", "last_updated_time": "2026-01-31T20:03:32.593153Z", "url": "https://connect.maton.ai/?session_token=...", "app": "woocommerce", "metadata": {} } } ``` Open the returned `url` in a browser to complete OAuth authorization. ### Delete Connection ```bash curl -s -X DELETE "https://ctrl.maton.ai/connections/{connection_id}" -H "Authorization: Bearer $MATON_API_KEY" ``` ### Specifying Connection If you have multiple WooCommerce connections, specify which one to use with the `Maton-Connection` header: ```bash curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products" -H "Authorization: Bearer $MATON_API_KEY" -H "Maton-Connection: 21fd90f9-5935-43cd-b6c8-bde9d915ca80" ``` If omitted, the gateway uses the default (oldest) active connection. ## API Reference ### Products #### List All Products ```bash GET /woocommerce/wp-json/wc/v3/products ``` Query parameters: - `page` - Current page (default: 1) - `per_page` - Items per page (default: 10, max: 100) - `search` - Search by product name - `status` - Filter by status: `draft`, `pending`, `private`, `publish` - `type` - Filter by type: `simple`, `grouped`, `external`, `variable` - `sku` - Filter by SKU - `category` - Filter by category ID - `tag` - Filter by tag ID - `featured` - Filter featured products - `on_sale` - Filter on-sale products - `min_price` / `max_price` - Filter by price range - `stock_status` - Filter by stock status: `instock`, `outofstock`, `onbackorder` - `orderby` - Sort by: `date`, `id`, `include`, `title`, `slug`, `price`, `popularity`, `rating` - `order` - Sort order: `asc`, `desc` **Example:** ```bash curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products?per_page=20&status=publish" -H "Authorization: Bearer $MATON_API_KEY" ``` **Response:** ```json [ { "id": 123, "name": "Premium T-Shirt", "slug": "premium-t-shirt", "type": "simple", "status": "publish", "sku": "TSH-001", "price": "29.99", "regular_price": "34.99", "sale_price": "29.99", "stock_quantity": 50, "stock_status": "instock", "categories": [{"id": 15, "name": "Apparel"}], "images": [{"id": 456, "src": "https://..."}] } ] ``` #### Get a Product ```bash GET /woocommerce/wp-json/wc/v3/products/{id} ``` **Example:** ```bash curl -s -X GET "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products/123" -H "Authorization: Bearer $MATON_API_KEY" ``` #### Create a Product ```bash POST /woocommerce/wp-json/wc/v3/products Content-Type: application/json { "name": "New Product", "type": "simple", "regular_price": "49.99", "description": "Full product description", "short_description": "Brief description", "sku": "PROD-001", "manage_stock": true, "stock_quantity": 100, "categories": [{"id": 15}], "images": [{"src": "https://example.com/image.jpg"}] } ``` **Example:** ```bash curl -s -X POST "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"name": "Premium Widget", "type": "simple", "regular_price": "19.99", "sku": "WDG-001"}' ``` #### Update a Product ```bash PUT /woocommerce/wp-json/wc/v3/products/{id} ``` **Example:** ```bash curl -s -X PUT "https://gateway.maton.ai/woocommerce/wp-json/wc/v3/products/123" -H "Content-Type: application/json" -H "Authorization: Bearer $MATON_API_KEY" -d '{"regular_price": "24.99", "sale_price": "19.99"}' ``` #### Delete a Product ```bash DELETE /woocommerce/wp-json/wc/v3/products/{id} ``` Query parameters: - `force` - Set to `true` to permanently delete (default: `false` moves to trash) #### Duplicate a Product ```bash POST /woocommerce/wp-json/wc/v3/products/{id}/duplicate ``` ### Product Variations For variable products, manage individual variations: #### List Variations ```bash GET /woocommerce/wp-json/wc/v3/products/{product_id}/variations ``` #### Create Variation ```bash POST /woocommerce/wp-json/wc/v3/products/{product_id}/variations Content-Type: application/json { "regular_price": "29.99", "sku": "TSH-001-RED-M", "attributes": [ {"id": 1, "option": "Red"}, {"id": 2, "option": "Medium"} ] } ``` #### Update Variation ```bash PUT /woocommerce/wp-json/wc/v3/products/{product_id}/variations/{id} ``` #### Delete Variation ```bash DELETE /woocommerce/wp-json/wc/v3/products/{product_id}/variations/{id} ``` #### Batch Update Variations ```bash POST /woocommerce/wp-json/wc/v3/products/{product_id}/variations/batch ``` ### Product Attributes #### List Attributes ```bash GET /woocommerce/wp-json/wc/v3/products/attributes ``` #### Create Attribute ```bash POST /woocommerce/wp-json/wc/v3/products/attributes Content-Type: application/json { "name": "Color", "slug": "color", "type": "select", "order_by": "menu_order" } ``` #### Get/Update/Delete Attribute ```bash GET /woocommerce/wp-json/wc/v3/products/attributes/{id} PUT /woocommerce/wp-json/wc/v3/products/attributes/{id} DELETE /woocommerce/wp-json/wc/v3/products/attributes/{id} ``` ### Attribute Terms ```bash GET /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms POST /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms GET /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms/{id} PUT /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms/{id} DELETE /woocommerce/wp-json/wc/v3/products/attributes/{attribute_id}/terms/{id} ``` ### Product Categories #### List Categories ```bash GET /woocommerce/wp-json/wc/v3/products/categories ``` #### Create Category ```bash POST /woocommerce/wp-json/wc/v3/products/categories Content-Type: application/json { "name": "Electronics", "parent": 0, "description": "Electronic products" } ``` #### Get/Update/Delete Category ```bash GET /woocommerce/wp-json/wc/v3/products/categories/{id} PUT /woocommerce/wp-json/wc/v3/products/categories/{id} DELETE /woocommerce/wp-json/wc/v3/products/categories/{id} ``` ### Product Tags ```bash GET /woocommerce/wp-json/wc/v3/products/tags POST /woocommerce/wp-json/wc/v3/products/tags GET /woocommerce/wp-json/wc/v3/products/tags/{id} PUT /woocommerce/wp-json/wc/v3/products/tags/{id} DELETE /woocommerce/wp-json/wc/v3/products/tags/{id} ``` ### Product Shipping Classes ```bash GET /woocommerce/wp-json/wc/v3/products/shipping_classes POST /woocommerce/wp-json/wc/v3/products/shipping_classes GET /woocommerce/wp-json/wc/v3/products/shipping_classes/{id} PUT /woocommerce/wp-json/wc/v3/products/shipping_classes/{id} DELETE /woocommerce/wp-json/wc/v3/products/shipping_classes/{id} ```