Node reference
WooCommerce
WooCommerce node reference - all 148 operations, the credential it needs, and a worked example.
WooCommerce REST API v3 (Commerce). 148 operations: orders, order notes and refunds; products (including duplicate, related, suggested and custom-field names), variations (including generation from attributes), categories, brands, tags, attributes and terms, shipping classes and reviews; customers and their downloads; coupons; tax rates and classes; reports; webhooks; payment gateways; shipping zones, zone locations, zone methods and method types; settings; system status and tools; and store reference data. Every writable resource also exposes its batch endpoint.
Credential: WooCommerce REST API keys - see Credentials.
Each operation below lists the permission it needs. Permissions are chosen from a single dropdown when the REST API key is generated, under WooCommerce -> Settings -> Advanced -> REST API. WooCommerce has no OAuth2 and no per-endpoint scopes at all: a key carries exactly ONE of three levels - Read (GET and HEAD only), Write (POST, PUT, PATCH and DELETE only) or Read/Write (both). The trap is that Write is NOT a superset of Read. WC_REST_Authentication::check_permissions() matches the HTTP verb against the level exactly, so a write-only key gets a 401 on every GET, which is why the read rows below name read rather than saying any key will do; a workflow that both reads and writes needs Read/Write. A key's level is also fixed at creation, so widening it means generating a replacement and re-pasting the credential. Two refusals here are NOT a key permission. First, the key belongs to a WordPress USER and that user's capabilities are checked on top: orders, customers, coupons, webhooks, settings, system status and tax rates all need manage_woocommerce, so a key minted under a Subscriber or Customer account authenticates fine and then answers woocommerce_rest_cannot_view on nearly everything - the fix is the user's role (Shop Manager or Administrator), not the key. Second, this node authenticates by sending the consumer key and secret as HTTP Basic, which WooCommerce accepts only over HTTPS; over plain http:// it requires OAuth 1.0a one-legged signing instead, which Pipory does not implement, so a store served over HTTP cannot be automated here at any permission level. If a run fails with a permission error, the node names the missing permission in the error - grant it and re-run; you do not need to rebuild the workflow.
| Operation | What it does | Permission |
|---|
createOrder | Create order | write (or read_write) |
getOrder | Get order | read (or read_write) |
listOrders | List / search orders | read (or read_write) |
updateOrder | Update order | write (or read_write) |
updateOrderStatus | Update order status | write (or read_write) |
deleteOrder | Delete order | write (or read_write) |
batchOrders | Batch orders (create / update / delete) | write (or read_write) |
| Operation | What it does | Permission |
|---|
listOrderNotes | List order notes | read (or read_write) |
createOrderNote | Add order note | write (or read_write) |
getOrderNote | Get order note | read (or read_write) |
deleteOrderNote | Delete order note | write (or read_write) |
| Operation | What it does | Permission |
|---|
listOrderRefunds | List refunds on an order | read (or read_write) |
createOrderRefund | Refund an order | write (or read_write) |
getOrderRefund | Get refund | read (or read_write) |
deleteOrderRefund | Delete refund | write (or read_write) |
listAllRefunds | List all refunds in the store | read (or read_write) |
| Operation | What it does | Permission |
|---|
createProduct | Create product | write (or read_write) |
getProduct | Get product | read (or read_write) |
listProducts | List / search products | read (or read_write) |
updateProduct | Update product | write (or read_write) |
deleteProduct | Delete product | write (or read_write) |
duplicateProduct | Duplicate product | write (or read_write) |
batchProducts | Batch products (create / update / delete) | write (or read_write) |
listRelatedProducts | List related products | read (or read_write) |
listSuggestedProducts | List suggested products | read (or read_write) |
listProductCustomFieldNames | List product custom-field names | read (or read_write) |
| Operation | What it does | Permission |
|---|
listVariations | List variations | read (or read_write) |
createVariation | Create variation | write (or read_write) |
getVariation | Get variation | read (or read_write) |
updateVariation | Update variation | write (or read_write) |
deleteVariation | Delete variation | write (or read_write) |
batchVariations | Batch variations | write (or read_write) |
generateVariations | Generate variations from attributes | write (or read_write) |
listAllVariations | List all variations in the store | read (or read_write) |
| Operation | What it does | Permission |
|---|
listProductCategories | List product categories | read (or read_write) |
createProductCategory | Create product category | write (or read_write) |
getProductCategory | Get product category | read (or read_write) |
updateProductCategory | Update product category | write (or read_write) |
deleteProductCategory | Delete product category | write (or read_write) |
batchProductCategories | Batch product categories | write (or read_write) |
| Operation | What it does | Permission |
|---|
listProductBrands | List product brands | read (or read_write) |
createProductBrand | Create product brand | write (or read_write) |
getProductBrand | Get product brand | read (or read_write) |
updateProductBrand | Update product brand | write (or read_write) |
deleteProductBrand | Delete product brand | write (or read_write) |
batchProductBrands | Batch product brands | write (or read_write) |
| Operation | What it does | Permission |
|---|
listProductTags | List product tags | read (or read_write) |
createProductTag | Create product tag | write (or read_write) |
getProductTag | Get product tag | read (or read_write) |
updateProductTag | Update product tag | write (or read_write) |
deleteProductTag | Delete product tag | write (or read_write) |
batchProductTags | Batch product tags | write (or read_write) |
| Operation | What it does | Permission |
|---|
listProductAttributes | List product attributes | read (or read_write) |
createProductAttribute | Create product attribute | write (or read_write) |
getProductAttribute | Get product attribute | read (or read_write) |
updateProductAttribute | Update product attribute | write (or read_write) |
deleteProductAttribute | Delete product attribute | write (or read_write) |
batchProductAttributes | Batch product attributes | write (or read_write) |
| Operation | What it does | Permission |
|---|
listAttributeTerms | List attribute terms | read (or read_write) |
createAttributeTerm | Create attribute term | write (or read_write) |
getAttributeTerm | Get attribute term | read (or read_write) |
updateAttributeTerm | Update attribute term | write (or read_write) |
deleteAttributeTerm | Delete attribute term | write (or read_write) |
batchAttributeTerms | Batch attribute terms | write (or read_write) |
| Operation | What it does | Permission |
|---|
listShippingClasses | List shipping classes | read (or read_write) |
createShippingClass | Create shipping class | write (or read_write) |
getShippingClass | Get shipping class | read (or read_write) |
updateShippingClass | Update shipping class | write (or read_write) |
deleteShippingClass | Delete shipping class | write (or read_write) |
batchShippingClasses | Batch shipping classes | write (or read_write) |
suggestShippingClassSlug | Suggest a shipping class slug | read (or read_write) |
| Operation | What it does | Permission |
|---|
listProductReviews | List product reviews | read (or read_write) |
createProductReview | Create product review | write (or read_write) |
getProductReview | Get product review | read (or read_write) |
updateProductReview | Update / moderate product review | write (or read_write) |
deleteProductReview | Delete product review | write (or read_write) |
batchProductReviews | Batch product reviews | write (or read_write) |
| Operation | What it does | Permission |
|---|
createCustomer | Create customer | write (or read_write) |
getCustomer | Get customer | read (or read_write) |
listCustomers | List / search customers | read (or read_write) |
updateCustomer | Update customer | write (or read_write) |
deleteCustomer | Delete customer | write (or read_write) |
listCustomerDownloads | List a customer's downloads | read (or read_write) |
batchCustomers | Batch customers (create / update / delete) | write (or read_write) |
| Operation | What it does | Permission |
|---|
createCoupon | Create coupon | write (or read_write) |
getCoupon | Get coupon | read (or read_write) |
listCoupons | List / search coupons | read (or read_write) |
updateCoupon | Update coupon | write (or read_write) |
deleteCoupon | Delete coupon | write (or read_write) |
batchCoupons | Batch coupons (create / update / delete) | write (or read_write) |
| Operation | What it does | Permission |
|---|
listTaxRates | List tax rates | read (or read_write) |
createTaxRate | Create tax rate | write (or read_write) |
getTaxRate | Get tax rate | read (or read_write) |
updateTaxRate | Update tax rate | write (or read_write) |
deleteTaxRate | Delete tax rate | write (or read_write) |
batchTaxRates | Batch tax rates | write (or read_write) |
listTaxClasses | List tax classes | read (or read_write) |
createTaxClass | Create tax class | write (or read_write) |
deleteTaxClass | Delete tax class | write (or read_write) |
| Operation | What it does | Permission |
|---|
listReports | List available reports | read (or read_write) |
getSalesReport | Sales report | read (or read_write) |
getTopSellersReport | Top sellers report | read (or read_write) |
getCouponsTotals | Coupon totals | read (or read_write) |
getCustomersTotals | Customer totals | read (or read_write) |
getOrdersTotals | Order totals | read (or read_write) |
getProductsTotals | Product totals | read (or read_write) |
getReviewsTotals | Review totals | read (or read_write) |
| Operation | What it does | Permission |
|---|
listWebhooks | List webhooks | read (or read_write) |
createWebhook | Create webhook | write (or read_write) |
getWebhook | Get webhook | read (or read_write) |
updateWebhook | Update webhook | write (or read_write) |
deleteWebhook | Delete webhook | write (or read_write) |
batchWebhooks | Batch webhooks | write (or read_write) |
| Operation | What it does | Permission |
|---|
listPaymentGateways | List payment gateways | read (or read_write) |
getPaymentGateway | Get payment gateway | read (or read_write) |
updatePaymentGateway | Update payment gateway | write (or read_write) |
| Operation | What it does | Permission |
|---|
listShippingZones | List shipping zones | read (or read_write) |
createShippingZone | Create shipping zone | write (or read_write) |
getShippingZone | Get shipping zone | read (or read_write) |
updateShippingZone | Update shipping zone | write (or read_write) |
deleteShippingZone | Delete shipping zone | write (or read_write) |
getShippingZoneLocations | Get shipping zone locations | read (or read_write) |
updateShippingZoneLocations | Set shipping zone locations | write (or read_write) |
listShippingZoneMethods | List methods in a zone | read (or read_write) |
createShippingZoneMethod | Add a method to a zone | write (or read_write) |
getShippingZoneMethod | Get a zone's method | read (or read_write) |
updateShippingZoneMethod | Update a zone's method | write (or read_write) |
deleteShippingZoneMethod | Remove a method from a zone | write (or read_write) |
listShippingMethods | List shipping method types | read (or read_write) |
getShippingMethod | Get a shipping method type | read (or read_write) |
| Operation | What it does | Permission |
|---|
listSettingGroups | List setting groups | read (or read_write) |
listSettingOptions | List options in a group | read (or read_write) |
getSettingOption | Get a setting option | read (or read_write) |
updateSettingOption | Update a setting option | write (or read_write) |
batchSettingOptions | Batch update options in one group | write (or read_write) |
batchSettings | Batch update settings across groups | write (or read_write) |
| Operation | What it does | Permission |
|---|
getSystemStatus | Get system status | read (or read_write) |
listSystemStatusTools | List system status tools | read (or read_write) |
getSystemStatusTool | Get a system status tool | read (or read_write) |
runSystemStatusTool | Run a system status tool | write (or read_write) |
| Operation | What it does | Permission |
|---|
getDataIndex | List data resources | read (or read_write) |
listContinents | List continents | read (or read_write) |
getContinent | Get a continent | read (or read_write) |
listCountries | List countries | read (or read_write) |
getCountry | Get a country | read (or read_write) |
listCurrencies | List currencies | read (or read_write) |
getCurrency | Get a currency | read (or read_write) |
getCurrentCurrency | Get the store's currency | read (or read_write) |