WooCommerce

1. Overview

WooCommerce is a flexible, open-source eCommerce plugin for WordPress. It allows you to build a fully functional online store to sell anything, from physical products to digital downloads.

With the GoInsight Woocommerce node, you can seamlessly integrate your eCommerce operations into your automated workflows. This enables you to manage the entire lifecycle of your store's key resources, including:

• Customer Management: Create, retrieve, update, delete, and search for customers in your store.
• Order Processing: Automate the creation, retrieval, updating, and deletion of orders.
• Product Catalog: Manage your products by creating, finding, updating, and deleting them programmatically.

2. Prerequisites

Before using this node, you need to have a valid WooCommerce store set up on a WordPress website. You will also need administrator-level access to your WordPress dashboard to generate the necessary API credentials.

3. Credentials

For a detailed guide on how to obtain and configure your credentials, please refer to our official documentation: Credential Configuration Guide.

4. Supported Operations

The Woocommerce node is organized around three primary resources: Customers, Orders, and Products. The summary below provides an overview of all supported operations.

Summary

Operation Details

Create a Customer

Create a new WooCommerce customer using the WooCommerce REST API. Supports creating customers with personal information, billing and shipping addresses, and custom metadata. Returns complete customer data with proper error handling and status reporting.

Input Parameters:

• Email: Customer email address, required and must be valid email format

Options:

• FirstName: Customer first name, optional
• LastName: Customer last name, optional
• Username: Customer username, optional (system will auto-generate if empty)
• Password: Customer password, optional (system will auto-generate if empty)
• Billing: Billing address information in JSON format, optional
• Shipping: Shipping address information in JSON format, optional
• MetaData: Additional metadata in JSON format, optional

Output:

• CustomerId (number)： The ID of the newly created customer, 0 if creation failed.
• CustomerEmail (string)： The email address of the created customer.
• CustomerName (string)： The full name of the created customer (first name + last name).
• Username (string)： The username of the created customer.
• DateCreated (string)： The creation timestamp of the customer account.
• IsPayingCustomer (bool)： Whether the customer is a paying customer.
• Customer (object)： The complete customer details object with all customer information.
• StatusCode (number)： HTTP status code: 201 (created), 400 (bad request), 401 (unauthorized), 403 (forbidden), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Delete a Customer

Delete a WooCommerce customer using the WooCommerce REST API. Supports both soft deletion (move to trash) and permanent deletion (force delete). Returns information about the deleted customer with proper error handling and status reporting.

Input Parameters:

• CustomerID: The ID of the customer to delete, must be a valid integer

Options:

• Force: Whether to permanently delete (true) or move to trash (false). Default is false.

Output:

• CustomerId (number)： The ID of the deleted customer.
• CustomerEmail (string)： The email address of the deleted customer.
• CustomerName (string)： The full name of the deleted customer.
• Username (string)： The username of the deleted customer.
• ForceDeleted (bool)： Whether the customer was permanently deleted (true) or moved to trash (false).
• DeletedAt (string)： The timestamp when the deletion operation was performed.
• IsPayingCustomer (bool)： Whether the deleted customer was a paying customer before deletion.
• TotalOrders (number)： The total number of orders the customer had before deletion.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Find Customers

Retrieve a paginated list of WooCommerce customers using the WooCommerce REST API. Supports advanced filtering by email, role, search terms, and comprehensive sorting options with pagination controls. Returns detailed customer information with proper error handling and status reporting.

Options:

• Context: Response context, optional, defaults to view
• Page: Page number for pagination, starting from 1. Default is 1.
• PerPage: Number of items per page (1-100). Default is 10.
• Search: Search term to filter customers by name, email, or other fields.
• Exclude: Comma-separated list of customer IDs to exclude from results.
• Include: Comma-separated list of customer IDs to include in results.
• Offset: Number of items to skip before starting to return results. Default is 0.
• Order: Sort order: 'asc' for ascending or 'desc' for descending. Default is 'asc'.
• OrderBy: Sort field: 'name', 'date', 'email', or other valid fields. Default is 'name'.
• Email: Filter customers by specific email address.
• Role: Filter customers by user role (e.g., 'customer', 'subscriber').

Output:

• Customers (object-array)： A JSON array of customer objects with detailed information about each customer.
• TotalCount (number)： Total number of customers matching the filter criteria.
• TotalPages (number)： Total number of pages based on per_page setting.
• CurrentPage (number)： Current page number being retrieved.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Get a Customer

Retrieve detailed information for a specific WooCommerce customer using the WooCommerce REST API. Returns complete customer data including personal information, contact details, and customer status. Supports proper error handling and status reporting.

Input Parameters:

• CustomerID: The ID of the customer to retrieve, must be a valid integer

Output:

• CustomerId (number)： The ID of the retrieved customer.
• CustomerEmail (string)： The email address of the customer.
• CustomerName (string)： The full name of the customer (first name + last name).
• Username (string)： The username of the customer.
• DateCreated (string)： The creation timestamp of the customer account.
• IsPayingCustomer (bool)： Whether the customer is a paying customer.
• Customer (object)： The complete customer details object with all customer information.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Update a Customer

Update an existing WooCommerce customer using the WooCommerce REST API. Supports updating customer information including personal details, billing and shipping addresses, and custom metadata. Only updates provided non-empty fields while preserving existing data. Returns complete customer data with proper error handling and status reporting.

Input Parameters:

• CustomerID: The ID of the customer to update, must be a valid integer

Options:

• Email: Customer email address, optional (must be valid email format if provided)
• FirstName: Customer first name, optional
• LastName: Customer last name, optional
• Username: Customer username, optional
• Password: Customer password, optional
• Billing: Billing address information in JSON format, optional
• Shipping: Shipping address information in JSON format, optional
• MetaData: Additional metadata in JSON format, optional

Output:

• CustomerId (number)： The ID of the updated customer.
• CustomerEmail (string)： The updated email address of the customer.
• CustomerName (string)： The updated full name of the customer.
• Username (string)： The updated username of the customer.
• DateModified (string)： The modification timestamp of the customer record.
• IsPayingCustomer (bool)： Whether the customer is a paying customer.
• Customer (object)： The complete updated customer details object.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Create a Order

Create a new WooCommerce order using the WooCommerce REST API. Supports creating orders with customer information, billing and shipping addresses, line items, and payment details. Returns complete order data with proper error handling and status reporting.

Options:

• PaymentMethod: Payment method ID, optional
• PaymentMethodTitle: Payment method title, optional
• Status: Order status, default is pending
• Currency: Currency code, optional
• CustomerID: Customer ID, optional
• CustomerNote: Customer note, optional
• Billing: Billing address information in JSON format, optional
• Shipping: Shipping address information in JSON format, optional
• LineItems: Order line items in JSON format, optional
• MetaData: Additional metadata in JSON format, optional
• SetPaid: Whether to set order as paid, optional
• FeeLines: Fee lines in JSON format, optional
• ShippingLines: Shipping lines in JSON format, optional
• CouponLines: Coupon lines in JSON format, optional

Output:

• OrderId (number)： The ID of the newly created order, 0 if creation failed.
• OrderNumber (string)： The order number of the created order.
• OrderStatus (string)： The status of the created order.
• OrderTotal (string)： The total amount of the created order.
• Currency (string)： The currency of the created order.
• CustomerId (number)： The customer ID associated with the order.
• DateCreated (string)： The creation timestamp of the order.
• Order (object)： The complete order details object with all order information.
• StatusCode (number)： HTTP status code: 201 (created), 400 (bad request), 401 (unauthorized), 403 (forbidden), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Delete a Order

Delete a WooCommerce order using the WooCommerce REST API. Supports both soft deletion (move to trash) and permanent deletion (force delete). Returns information about the deleted order with proper error handling and status reporting.

Input Parameters:

• OrderID: The ID of the order to delete, must be a valid integer

Options:

• Force: Whether to permanently delete (true) or move to trash (false). Default is false.

Output:

• Order (object)： The deleted order information object with all order details before deletion.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Find Orders

Retrieve a paginated list of WooCommerce orders using the WooCommerce REST API. Supports advanced filtering by customer, product, status, date range, and comprehensive sorting options with pagination controls. Returns detailed order information with proper error handling and status reporting.

Options:

• Context: Response context, optional, defaults to view
• Page: Page number for pagination, starting from 1. Default is 1.
• PerPage: Number of items per page (1-100). Default is 10.
• Search: Search term to filter orders.
• After: Limit response to orders published after a given ISO8601 date.
• Before: Limit response to orders published before a given ISO8601 date.
• Exclude: Comma-separated list of order IDs to exclude from results.
• Include: Comma-separated list of order IDs to include in results.
• Offset: Number of items to skip before starting to return results. Default is 0.
• Order: Sort order: 'asc' for ascending or 'desc' for descending. Default is 'desc'.
• OrderBy: Sort field: 'date', 'id', 'include', 'title', 'slug'. Default is 'date'.
• Status: Filter orders by order status.
• Customer: Limit result set to orders assigned to a specific customer ID.
• Product: Limit result set to orders that contain a specific product ID.
• Parent: Limit result set to orders assigned to a specific parent order.
• ParentExclude: Ensure result set excludes specific parent order IDs.
• Dp: Number of decimal places to return for prices. Default is 2.

Output:

• Orders (object-array)： A JSON array of order objects with detailed information about each order.
• TotalCount (number)： Total number of orders matching the filter criteria.
• TotalPages (number)： Total number of pages based on per_page setting.
• CurrentPage (number)： Current page number being retrieved.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Get a Order

Retrieve detailed information for a specific WooCommerce order using the WooCommerce REST API. Returns complete order data including line items, customer information, billing and shipping addresses, payment details, and order status. Supports proper error handling and status reporting.

Input Parameters:

• OrderID: The ID of the order to retrieve, must be a valid integer

Output:

• Order (object)： Complete order details object with all order information including line items, billing, shipping, and payment details.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Update a Order

Update an existing WooCommerce order using the WooCommerce REST API. Supports updating order information including payment methods, status, billing and shipping addresses, line items, and custom metadata. Only updates provided non-empty fields while preserving existing data. Returns complete order data with proper error handling and status reporting.

Input Parameters:

• OrderID: The ID of the order to update, must be a valid integer

Options:

• PaymentMethod: Payment method ID, optional
• PaymentMethodTitle: Payment method title, optional
• SetPaid: Whether to mark order as paid, optional
• Status: Order status, optional
• Currency: Currency code, optional
• CustomerID: Customer ID, optional
• CustomerNote: Customer note, optional
• Billing: Billing address information in JSON format, optional
• Shipping: Shipping address information in JSON format, optional
• LineItems: Order line items in JSON format, optional
• MetaData: Additional metadata in JSON format, optional
• FeeLines: Fee lines in JSON format, optional
• ShippingLines: Shipping lines in JSON format, optional
• CouponLines: Coupon lines in JSON format, optional

Output:

• OrderId (number)： The ID of the updated order.
• OrderNumber (string)： The updated order number.
• OrderStatus (string)： The updated status of the order.
• OrderTotal (string)： The updated total amount of the order.
• DateModified (string)： The modification timestamp of the order.
• Order (object)： The complete updated order details object.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Create a Product

Create a new WooCommerce product using the WooCommerce REST API. Supports creating products with detailed specifications including pricing, inventory, categories, and images. Returns complete product data with proper error handling and status reporting.

Input Parameters:

• Name: Product name, required parameter

Options:

• ProductType: Product type (simple, grouped, external, variable), default is simple
• Status: Product status (publish, draft, pending, private), default is publish
• Description: Product detailed description, optional
• ShortDescription: Product short description, optional
• Sku: Product SKU, optional
• RegularPrice: Product regular price, optional
• SalePrice: Product sale price, optional
• StockQuantity: Stock quantity, optional
• StockStatus: Stock status (instock, outofstock, onbackorder), default is instock
• Weight: Product weight, optional
• Categories: Product categories in JSON format, optional
• Images: Product images in JSON format, optional
• Tags: Product tags in JSON format, optional
• Attributes: Product attributes in JSON format, optional
• MetaData: Additional metadata in JSON format, optional
• Featured: Whether product is featured, optional
• ManageStock: Whether to manage stock, optional
• Dimensions: Product dimensions in JSON format, optional

Output:

• ProductId (number)： The ID of the newly created product, 0 if creation failed.
• ProductName (string)： The name of the created product.
• ProductSku (string)： The SKU of the created product.
• ProductType (string)： The type of the created product.
• ProductStatus (string)： The status of the created product.
• ProductPrice (string)： The current price of the created product.
• ProductUrl (string)： The permanent link of the created product.
• DateCreated (string)： The creation timestamp of the product.
• StatusCode (number)： HTTP status code: 201 (created), 400 (bad request), 401 (unauthorized), 403 (forbidden), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Delete a Product

Delete a WooCommerce product using the WooCommerce REST API. Supports both soft deletion (move to trash) and permanent deletion (force delete). Returns information about the deleted product with proper error handling and status reporting.

Input Parameters:

• ProductID: The ID of the product to delete, must be a valid integer

Options:

• Force: Whether to permanently delete (true) or move to trash (false). Default is false.

Output:

• ProductId (number)： The ID of the deleted product.
• ProductName (string)： The name of the deleted product.
• ProductSku (string)： The SKU of the deleted product.
• ProductType (string)： The type of the deleted product.
• ForceDeleted (bool)： Whether the product was permanently deleted (true) or moved to trash (false).
• DeletedAt (string)： The timestamp when the deletion operation was performed.
• PreviousPrice (string)： The price of the product before deletion.
• PreviousStock (number)： The stock quantity of the product before deletion.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Find Products

Retrieve a paginated list of WooCommerce products using the WooCommerce REST API. Supports advanced filtering by category, price range, stock status, featured status, and comprehensive sorting options with pagination controls. Returns detailed product information with proper error handling and status reporting.

Options:

• Context: Response context, optional, defaults to view
• Pagination: Pagination and sorting parameters object with fields: page (int, default 1), per_page (int, default 10), offset (int, default 0), order (string, default 'desc'), orderby (string, default 'date')
• Search: Search term to filter products by name or description.
• Status: Filter products by status (publish, draft, pending, private).
• ProductType: Filter products by type (simple, grouped, external, variable).
• Category: Filter products by category ID.
• Featured: Filter by featured products (true/false).
• OnSale: Filter products on sale (true/false).
• MinPrice: Filter products with price greater than or equal to this value.
• MaxPrice: Filter products with price less than or equal to this value.
• StockStatus: Filter products by stock status (instock, outofstock, onbackorder).
• After: Limit response to products published after a given ISO8601 date.
• Before: Limit response to products published before a given ISO8601 date.
• Exclude: Comma-separated list of product IDs to exclude from results.
• Include: Comma-separated list of product IDs to include in results.
• Parent: Limit result set to products assigned to a specific parent product.
• ParentExclude: Ensure result set excludes specific parent product IDs.
• Slug: Limit result set to products with specific slug.
• Sku: Limit result set to products with specific SKU.
• Tag: Limit result set to products assigned to specific tag ID.
• ShippingClass: Limit result set to products assigned to specific shipping class.
• Attribute: Limit result set to products with specific attribute.
• AttributeTerm: Limit result set to products with specific attribute term.
• TaxClass: Limit result set to products with specific tax class.

Output:

• Products (object-array)： A JSON array of product objects with detailed information about each product.
• TotalCount (number)： Total number of products matching the filter criteria.
• TotalPages (number)： Total number of pages based on per_page setting.
• CurrentPage (number)： Current page number being retrieved.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Get a Product

Retrieve detailed information for a specific WooCommerce product using the WooCommerce REST API. Returns complete product data including pricing, stock, categories, and product attributes. Supports proper error handling and status reporting.

Input Parameters:

• ProductID: The ID of the product to retrieve, must be a valid integer

Output:

• ProductId (number)： The ID of the retrieved product.
• ProductName (string)： The name of the product.
• ProductSku (string)： The SKU (Stock Keeping Unit) of the product.
• ProductType (string)： The type of the product (simple, grouped, external, variable).
• ProductStatus (string)： The status of the product (publish, draft, pending, private).
• ProductPrice (string)： The current price of the product.
• StockQuantity (number)： The stock quantity of the product.
• Product (object)： The complete product details object with all product information.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

Update a Product

Update an existing WooCommerce product using the WooCommerce REST API. Supports updating product information including basic details, pricing, inventory, categories, images, and attributes. Only updates provided non-empty fields while preserving existing data. Returns complete product data with proper error handling and status reporting.

Input Parameters:

• ProductID: The ID of the product to update, must be a valid integer

Options:

• Name: Product name, optional
• ProductType: Product type (simple, grouped, external, variable), optional
• Status: Product status (publish, draft, pending, private), optional
• Featured: Whether product is featured (true/false), optional
• Description: Product detailed description, optional
• ShortDescription: Product short description, optional
• Sku: Product SKU, optional
• RegularPrice: Product regular price, optional
• SalePrice: Product sale price, optional
• ManageStock: Whether to manage stock (true/false), optional
• StockQuantity: Stock quantity, optional
• StockStatus: Stock status (instock, outofstock, onbackorder), optional
• Weight: Product weight, optional
• Dimensions: Product dimensions in JSON format, optional
• Categories: Product categories in JSON format, optional
• Tags: Product tags in JSON format, optional
• Images: Product images in JSON format, optional
• Attributes: Product attributes in JSON format, optional
• MetaData: Additional metadata in JSON format, optional

Output:

• ProductId (number)： The ID of the updated product.
• ProductName (string)： The updated name of the product.
• ProductSku (string)： The updated SKU of the product.
• ProductType (string)： The updated type of the product.
• ProductStatus (string)： The updated status of the product.
• ProductPrice (string)： The updated current price of the product.
• DateModified (string)： The modification timestamp of the product.
• Product (object)： The complete updated product details object.
• StatusCode (number)： HTTP status code: 200 (success), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (server error), -1 (parameter error).
• ErrorMessage (string)： Error description if operation fails, empty string on success.

5. Example Usage

This section guides you through creating a simple workflow to add a new product to your WooCommerce store.

The workflow will look like this: Start -> Create a Product -> Answer.

Step-by-Step Guide

1. Add the Tool Node:
   • In the workflow canvas, click the + icon to add a new node.
   • Select the "Tool" tab in the pop-up panel.
   • Find and select Woocommerce from the tool list.
   • In the list of supported operations for Woocommerce, click Create a Product to add the corresponding node to the canvas.
2. Configure the Node:
   • Click on the newly added Create a Product node to open its configuration panel on the right.
   • Credentials: In the credentials field at the top of the panel, click the dropdown menu and select your pre-configured Woocommerce credential.
   • Parameters: Fill in the input parameters for the product.
   • Name: Enter a title for your new product, such as "GoInsight Branded T-Shirt".
   • RegularPrice: Set the price for the product, for example, "25.99".
   • Description: Provide a detailed description of the product.
   • ShortDescription: Provide a brief summary of the product.
3. Run and Validate:
   • Once all required parameters are correctly filled, the error indicators on the workflow canvas will disappear.
   • Click the "Run" button in the top-right corner of the canvas to execute the workflow.
   • After a successful execution, you can click the log icon in the top-right corner to view the detailed input and output of the node, confirming that the operation was successful.

Final Workflow

After completing these steps, your workflow is fully configured. When you run it, a new product will be created in your WooCommerce store.

6. FAQs

Q: Why am I getting a 401 Unauthorized error?

A: This error indicates a problem with your API credentials. Please check the following:

• Ensure that your Consumer Key and Consumer Secret are correct.
• Verify that the user associated with the API key has the necessary read/write permissions in WooCommerce.
• Make sure your site is accessible and not behind a firewall that blocks API requests.

Q: My request failed with a 400 Bad Request error. What does that mean?

A: A 400 error typically means that a required parameter is missing or has an invalid format. For example, when creating a customer, the Email is required. Double-check the input parameters for the specific operation you are using and ensure all required fields are filled correctly.

Q: How do I format JSON fields like Billing or LineItems?

A: These fields expect a valid JSON string. For example, to add a line item when creating an order, the LineItems field should contain a JSON array like this: [{"product_id": 123, "quantity": 1}]. You can construct this JSON string using other nodes in your workflow before passing it to the Woocommerce node.

7. Official Documentation

For more in-depth information and advanced use cases, please refer to the official WooCommerce REST API documentation:

Woocommerce Official API Documentation