WooCommerce Component
Easily manage your customers, orders, and products in your WooCommerce platform
Component key: woo-commerce
Description
WooCommerce is an open-source eCommerce plugin for WordPress. The Woo Commerce component allows you to interact with customers, products, and orders in your eCommerce wordpress site.
Connections
WooCommerce Basic Auth
WooCommerce operates through your Wordpress site's built in API. To get started with WooCommerce, install the WooCommerce plugin on your Wordpress site.
Once installed, you will see a navigation item for the plugin in your Wordpress Admin Dashboard Under the settings tab, navigate to advanced and you will see a section on "page setup". Click into REST API, and you will be greeted with a screen to generate API keys. Add a new key and give it a description, make sure to take note of the Consumer Key, and the Consumer Secret.
When you add a WooCommerce step to an integration, a connection config variable will be created automatically for you:
Enter the Consumer Key and Consumer Secret that you previously noted, and you should be ready to start creating WooCommerce integrations.
For additional information regarding authentication, please refer to the WooCommerce docs.
| Input | Notes | Example |
|---|---|---|
| Domain | Provide a string value for the domain of your wordpress site. | www.mySite.com |
| Consumer Secret | ||
| Consumer Key |
Data Sources
Select Customer
Select a customer from a list of WooCommerce customers. | key: selectCustomer | type: picklist
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
Select Order
Select an order from a list of WooCommerce orders. | key: selectOrder | type: picklist
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
Select Product
Select a product from a list of WooCommerce products. | key: selectProduct | type: picklist
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
Select Product Category
Select a product category from a list of WooCommerce product categories. | key: selectProductCategory | type: picklist
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
Select Refund
Select a refund from a list of WooCommerce refunds. | key: selectRefund | type: picklist
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
Actions
Create Customer
Create a new customer record | key: createCustomer
| Input | Notes | Example |
|---|---|---|
| Billing Address 1 | Provide a string value for the address 1 of the billing address. | 123 Main Street |
| Billing Address 2 | Provide a string value for the address 2 of the billing address. | Suite 100 |
| Billing City | Provide a string value for the city of the billing address. | San Francisco |
| Company | Provide a string value for the company name. | Acme Inc. |
| Connection | The connection to be used. | |
| Country | Provide a string value for the country of the billing address. | US |
| Email Address | Provide a valid email address. | john.doe@example.com |
| First Name | Provide a string value for the first name. | John |
| Last Name | Provide a string value for the last name. | Doe |
| Phone | Provide a string value for the phone number of the billing address. | +1-555-123-4567 |
| Postal Code | Provide a string value for the postal code of the billing address. | 94103 |
| Shipping Address 1 | Provide a string value for the address 1 of the shipping address. | 123 Main Street |
| Shipping Address 2 | Provide a string value for the address 2 of the shipping address. | Suite 100 |
| Shipping City | Provide a string value for the city of the billing address. | San Francisco |
| Shipping Country | Provide a string value for the country of the billing address. | US |
| Shipping Postal Code | Provide a string value for the postal code of the billing address. | 94103 |
| Shipping State | Provide a string value for the state of the billing address. | CA |
| State | Provide a string value for the state of the billing address. | CA |
| Username | Provide a string value for the username. | john.doe |
| Optional Values | For each item, provide an optional key value pair to be injected into the request body. |
Create Order
Create a new order record | key: createOrder
| Input | Notes | Example |
|---|---|---|
| Billing Address 1 | Provide a string value for the address 1 of the billing address. | 123 Main Street |
| Billing Address 2 | Provide a string value for the address 2 of the billing address. | Suite 100 |
| Billing City | Provide a string value for the city of the billing address. | San Francisco |
| Billing Country | Provide a string value for the country of the billing address. | US |
| Billing Postal Code | Provide a string value for the postal code of the billing address. | 94103 |
| Billing State | Provide a string value for the state of the billing address. | CA |
| Connection | The connection to be used. | |
| Email Address | Provide a valid email address. | john.doe@example.com |
| First Name | Provide a string value for the first name. | John |
| Is Paid | Determines if the order has been paid for. | false |
| Last Name | Provide a string value for the last name. | Doe |
| Line Items | Provide a JSON array, with objects each specifying details of the line item. | |
| Payment Method Key | Provide the unique identifier of the payment method. | bacs |
| Payment Method Title | Provide the display title of the payment method. | Direct Bank Transfer |
| Phone | Provide a string value for the phone number of the billing address. | +1-555-123-4567 |
| Shipping Address 1 | Provide a string value for the address 1 of the shipping address. | 123 Main Street |
| Shipping Address 2 | Provide a string value for the address 2 of the shipping address. | Suite 100 |
| Shipping City | Provide a string value for the city of the billing address. | San Francisco |
| Shipping Country | Provide a string value for the country of the billing address. | US |
| Shipping Lines | Provide a JSON array, with objects each specifying shipping details | |
| Shipping Postal Code | Provide a string value for the postal code of the billing address. | 94103 |
| Shipping State | Provide a string value for the state of the billing address. | CA |
| Optional Values | For each item, provide an optional key value pair to be injected into the request body. |
Create Product
Create a new product record | key: createProduct
| Input | Notes | Example |
|---|---|---|
| Categories | For each item, provide an id of a category that the product belongs to. | |
| Connection | The connection to be used. | |
| Description | Provide a description for the product. | This is a high quality product with excellent features. |
| Images | For each item, provide a link to the image stored in your media library | |
| Price | Provide a number for the price of the product. | 19.99 |
| Product Name | Provide a string value for the name of the product. | Software Subscription |
| Product Type | Provide a string value for the type of the product. | simple |
| Summary | Provide a short summary for the product details. | High quality product with great value. |
| Optional Values | For each item, provide an optional key value pair to be injected into the request body. |
Create Product Category
Create a new product category record | key: createProductCategory
| Input | Notes | Example |
|---|---|---|
| Category Name | Provide a name for the category. | Electronics |
| Connection | The connection to be used. | |
| Description | Provide a description for the product. | This is a high quality product with excellent features. |
| Image Link | Provide a link to an image to represent your category. | http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg |
Create Refund
Create a refund on an existing order | key: createRefund
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Line Items | Provide a JSON array, with objects each specifying details of the line item. | |
| Order Id | Provide the unique identifier of the order. | 100 |
| Refund Amount | Provide a value for the refund amount. | 10.00 |
Delete Customer
Delete the information and metadata of the given user | key: deleteCustomer
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Customer | Provide a unique identifier for the desired customer. This value should be an id | someone@example.com |
Delete Order
Delete the information and metadata of an order | key: deleteOrder
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Order Id | Provide the unique identifier of the order. | 100 |
Delete Product
Delete the information and metadata of a given product | key: deleteProduct
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Product Id | Provide a unique identifier of the given product. | 100 |
Delete Product Category
Delete Product Category | key: deleteProductCategory
| Input | Notes | Example |
|---|---|---|
| Category Id | Provide a unique identifier of an existing category. | 100 |
| Connection | The connection to be used. |
Delete Refund
Delete the information and metadata of a refund | key: deleteRefund
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Order Id | Provide the unique identifier of the order. | 100 |
| Refund Id | Provide a unique identifier of an existing refund. | 100 |
Get Coupon Totals Report
Returns the information and metadata of a Coupon Totals Report | key: getCouponTotalsReport
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| End Date | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2024-12-31 |
| Start Date | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2024-01-15 |
| Period | Provide a value for the sales period. Default is today's date. |
Get Customer
Returns the information and metadata of the given user | key: getCustomer
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Customer | Provide a unique identifier for the desired customer. This value should be an id | someone@example.com |
Get Customer Totals Report
Returns the information and metadata of a Customer Totals Report | key: getCustomerTotalsReport
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| End Date | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2024-12-31 |
| Start Date | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2024-01-15 |
| Period | Provide a value for the sales period. Default is today's date. |
Get Order
Returns the information and metadata of an order | key: getOrder
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Order Id | Provide the unique identifier of the order. | 100 |
Get Order Totals Report
Returns the information and metadata of a Order Totals Report | key: getOrderTotalsReport
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. |
Get Product
Returns the information and metadata of a given product | key: getProduct
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Product Id | Provide a unique identifier of the given product. | 100 |
Get Product Category
Returns the information and metadata of the product category | key: getProductCategory
| Input | Notes | Example |
|---|---|---|
| Category Id | Provide a unique identifier of an existing category. | 100 |
| Connection | The connection to be used. |
Get Product Totals Report
Returns the information and metadata of a Product Totals Report | key: getProductTotalsReport
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. |
Get Refund
Returns the information and metadata of a refund | key: getRefund
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Order Id | Provide the unique identifier of the order. | 100 |
| Refund Id | Provide a unique identifier of an existing refund. | 100 |
Get Review Totals Report
Returns the information and metadata of a Review Totals Report | key: getReviewTotalsReport
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. |
Get Sales Report
Returns the information and metadata of a Sales Report | key: getSalesReport
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| End Date | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2024-12-31 |
| Start Date | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2024-01-15 |
| Period | Provide a value for the sales period. Default is today's date. |
Get Top Sellers Report
Returns the information and metadata of a Sales Report | key: getTopSellersReport
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| End Date | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2024-12-31 |
| Start Date | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2024-01-15 |
| Period | Provide a value for the sales period. Default is today's date. |
List Customers
Returns a list of all active customers | key: listCustomers
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Fetch All | If true, all pages will be fetched. | false |
| Page Offset | Provide an integer for the page offset since the first page. | 0 |
| Page Number | Provide an integer for the page number. | 1 |
| Extra Parameters | Extra parameters to be passed to the request. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
{
"data": {
"data": [
{
"id": "100",
"date_created": "2022-03-25T11:13:01",
"date_created_gmt": "2022-03-25T11:13:01",
"date_mofdified": "2022-03-25T11:13:01",
"email": "someone@example.com",
"first_name": "john",
"last_name": "doe",
"role": "customer",
"username": "someone.example"
}
],
"headers": {
"server": "",
"x-wp-total": 2,
"x-wp-totalPages": 2,
"link": "<https://wordpress-site.wpcomstaging.com/wp-json/wc/v3/products?per_page=1&offset=1&page=2>; rel=\"next\""
}
}
}
List Orders
Returns a list of all orders | key: listOrders
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Fetch All | If true, all pages will be fetched. | false |
| Page Offset | Provide an integer for the page offset since the first page. | 0 |
| Page Number | Provide an integer for the page number. | 1 |
| Extra Parameters | Extra parameters to be passed to the request. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
{
"data": {
"data": [
{
"id": "100",
"parent": "0",
"currenct": "USD",
"version": "6.3.1",
"prices_include_tax": false,
"date_created": "2022-03-25T11:13:01",
"date_mofdified": "2022-03-25T11:13:01",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "49.99",
"total_tax": "0.00",
"customer_id": "101",
"order_key": "wc_order_93u6803463"
}
],
"headers": {
"server": "",
"x-wp-total": 2,
"x-wp-totalPages": 2,
"link": "<https://wordpress-site.wpcomstaging.com/wp-json/wc/v3/products?per_page=1&offset=1&page=2>; rel=\"next\""
}
}
}
List Product Categories
Returns a list of all product categories | key: listProductCategories
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Fetch All | If true, all pages will be fetched. | false |
| Page Offset | Provide an integer for the page offset since the first page. | 0 |
| Page Number | Provide an integer for the page number. | 1 |
| Extra Parameters | Extra parameters to be passed to the request. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
List Products
Returns a list of all active products | key: listProducts
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Fetch All | If true, all pages will be fetched. | false |
| Page Offset | Provide an integer for the page offset since the first page. | 0 |
| Page Number | Provide an integer for the page number. | 1 |
| Extra Parameters | Extra parameters to be passed to the request. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
{
"data": {
"data": [
{
"id": "100",
"name": "Example Customer",
"slug": "example",
"permalink": "https://wordpress-site.com/myProduct",
"date_created": "2022-03-25T11:13:01",
"date_created_gmt": "2022-03-25T11:13:01",
"date_mofdified": "2022-03-25T11:13:01",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "",
"sku": "",
"price": 21.99
}
],
"headers": {
"server": "",
"x-wp-total": 2,
"x-wp-totalPages": 2,
"link": "<https://wordpress-site.wpcomstaging.com/wp-json/wc/v3/products?per_page=1&offset=1&page=2>; rel=\"next\""
}
}
}
List Refunds
Returns a list of all refunds on an existing order | key: listRefunds
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Fetch All | If true, all pages will be fetched. | false |
| Page Offset | Provide an integer for the page offset since the first page. | 0 |
| Order Id | Provide the unique identifier of the order. | 100 |
| Page Number | Provide an integer for the page number. | 1 |
| Extra Parameters | Extra parameters to be passed to the request. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
List Reports
Returns a list of all reports | key: listReports
| Input | Notes | Example |
|---|---|---|
| After | Limit response to resources published after a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Before | Limit response to resources published before a given ISO8601 compliant date. | 2024-01-15T10:30:00Z |
| Connection | The connection to be used. | |
| Fetch All | If true, all pages will be fetched. | false |
| Page Offset | Provide an integer for the page offset since the first page. | 0 |
| Page Number | Provide an integer for the page number. | 1 |
| Extra Parameters | Extra parameters to be passed to the request. | |
| Results Per Page | Provide an integer for the amount of items to be returned. | 100 |
| Search | Search for a specific string. | Product name |
Raw Request
Send raw HTTP request to WooCommerce | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | The connection to be used. | |
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/reports), The base URL is already included (https://{input_domain}/wp-json/wc/v3). For example, to connect to https://{input_domain}/wp-json/wc/v3/reports, only /reports is entered in this field. | /reports |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Update Customer
Update an existing customer record | key: updateCustomer
| Input | Notes | Example |
|---|---|---|
| Billing Address 1 | Provide a string value for the address 1 of the billing address. | 123 Main Street |
| Billing Address 2 | Provide a string value for the address 2 of the billing address. | Suite 100 |
| Billing City | Provide a string value for the city of the billing address. | San Francisco |
| Billing Country | Provide a string value for the country of the billing address. | US |
| Billing Postal Code | Provide a string value for the postal code of the billing address. | 94103 |
| Billing State | Provide a string value for the state of the billing address. | CA |
| Company | Provide a string value for the company name. | Acme Inc. |
| Connection | The connection to be used. | |
| Customer | Provide a unique identifier for the desired customer. This value should be an id | someone@example.com |
| Email Address | Provide a valid email address. | john.doe@example.com |
| First Name | Provide a string value for the first name. | John |
| Last Name | Provide a string value for the last name. | Doe |
| Phone | Provide a string value for the phone number of the billing address. | +1-555-123-4567 |
| Shipping Address 1 | Provide a string value for the address 1 of the shipping address. | 123 Main Street |
| Shipping Address 2 | Provide a string value for the address 2 of the shipping address. | Suite 100 |
| Shipping City | Provide a string value for the city of the billing address. | San Francisco |
| Shipping Country | Provide a string value for the country of the billing address. | US |
| Shipping Postal Code | Provide a string value for the postal code of the billing address. | 94103 |
| Shipping State | Provide a string value for the state of the billing address. | CA |
| Username | Provide a string value for the username. | john.doe |
Update Product
Create a new product record | key: updateProduct
| Input | Notes | Example |
|---|---|---|
| Categories | For each item, provide an id of a category that the product belongs to. | |
| Connection | The connection to be used. | |
| Description | Provide a description for the product. | This is a high quality product with excellent features. |
| Images | For each item, provide a link to the image stored in your media library | |
| Price | Provide a number for the price of the product. | 19.99 |
| Product Id | Provide a unique identifier of the given product. | 100 |
| Product Name | Provide a string value for the name of the product. | Software Subscription |
| Product Type | Provide a string value for the type of the product. | simple |
| Summary | Provide a short summary for the product details. | High quality product with great value. |
| Optional Values | For each item, provide an optional key value pair to be injected into the request body. |
Changelog
2025-10-02
Added inline data sources for customers, orders, products, product categories, and refunds to enhance data selection capabilities