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 Prismatic and WooCommerce, start by installing 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 string / Required domain | Provide a string value for the domain of your wordpress site. | www.mySite.com |
Consumer Secret password / Required password | ||
Consumer Key string / Required username |
Actions
Create Customer
Create a new customer record | key: createCustomer
| Input | Notes | Example |
|---|---|---|
Billing Address 1 string billingAddress1 | Provide a string value for the address 1 of the billing address. | 969 Market |
Billing Address 2 string billingAddress2 | Provide a string value for the address 2 of the billing address. | apt 2 |
Billing City string city | Provide a string value for the city of the billing address. | San Francisco |
Company string company | Provide a string value for the company name. | Acme Inc. |
Connection connection / Required connection | The connection to be used. | |
Country string country | Provide a string value for the country of the billing address. | US |
Email Address string / Required email | Provide a valid email address. | someone@example.com |
First Name string firstName | Provide a string value for the first name. | John |
Last Name string lastName | Provide a string value for the last name. | Doe |
Phone string phone | Provide a string value for the phone number of the billing address. | (555) 555-5555 |
Postal Code string postalcode | Provide a string value for the postal code of the billing address. | 94103 |
Shipping Address 1 string shippingAddress1 | Provide a string value for the address 1 of the shipping address. | 969 Market |
Shipping Address 2 string shippingAddress2 | Provide a string value for the address 2 of the shipping address. | apt 2 |
Shipping City string shippingCity | Provide a string value for the city of the billing address. | San Francisco |
Shipping Country string shippingCountry | Provide a string value for the country of the billing address. | US |
Shipping Postal Code string shippingPostalCode | Provide a string value for the postal code of the billing address. | 94103 |
Shipping State string shippingState | Provide a string value for the state of the billing address. | CA |
State string state | Provide a string value for the state of the billing address. | CA |
Username string username | Provide a string value for the username. | john.doe |
Optional Values string Key Value List 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 | Default | Notes | Example |
|---|---|---|---|
Billing Address 1 string billingAddress1 | Provide a string value for the address 1 of the billing address. | 969 Market | |
Billing Address 2 string billingAddress2 | Provide a string value for the address 2 of the billing address. | apt 2 | |
Billing City string billingCity | Provide a string value for the city of the billing address. | San Francisco | |
Billing Country string billingCountry | Provide a string value for the country of the billing address. | US | |
Billing Postal Code string billingPostalCode | Provide a string value for the postal code of the billing address. | 94103 | |
Billing State string billingState | Provide a string value for the state of the billing address. | CA | |
Connection connection / Required connection | The connection to be used. | ||
Email Address string email | Provide a valid email address. | someone@example.com | |
First Name string firstName | Provide a string value for the first name. | John | |
Is Paid boolean / Required isPaid | false | Determines if the order has been paid for. | |
Last Name string lastName | Provide a string value for the last name. | Doe | |
Line Items code lineItems | Provide a JSON array, with objects each specifying details of the line item. | ||
Payment Method Key string paymentMethod | Provide the unique identifier of the payment method. | bacs | |
Payment Method Title string paymentMethodTitle | Provide the unique identifier of the payment method. | bacs | |
Phone string phone | Provide a string value for the phone number of the billing address. | (555) 555-5555 | |
Shipping Address 1 string shippingAddress1 | Provide a string value for the address 1 of the shipping address. | 969 Market | |
Shipping Address 2 string shippingAddress2 | Provide a string value for the address 2 of the shipping address. | apt 2 | |
Shipping City string shippingCity | Provide a string value for the city of the billing address. | San Francisco | |
Shipping Country string shippingCountry | Provide a string value for the country of the billing address. | US | |
Shipping Lines code shippingLines | Provide a JSON array, with objects each specifying details | ||
Shipping Postal Code string shippingPostalCode | Provide a string value for the postal code of the billing address. | 94103 | |
Shipping State string shippingState | Provide a string value for the state of the billing address. | CA | |
Optional Values string Key Value List 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 code categories | For each item, provide an id of a category that the product belongs to. | |
Connection connection / Required connection | The connection to be used. | |
Description string description | Provide a description for the product. | This is an example description. |
Images code images | For each item, provide a link to the image stored in your | |
Price string price | Provide a number for the price of the product. | 21.99 |
Product Name string productName | Provide a string value for the name of the product. | Software Subscription |
Product Type string productType | Provide a string value for the name of the product. | simple |
Summary string summary | Provide a short summary for the product details. | This is an example short summary. |
Optional Values string Key Value List 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 string / Required categoryName | Provide a name for the category. | Example Category |
Connection connection / Required connection | The connection to be used. | |
Description string description | Provide a description for the product. | This is an example description. |
Image Link string imageLink | 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 connection / Required connection | The connection to be used. | |
Line Items code lineItems | Provide a JSON array, with objects each specifying details of the line item. | |
Order Id string / Required orderId | Provide the unique identifier of the order. | 34538345353 |
Refund Amount string refundAmount | Provide a value for the refund amount. | 30 |
Delete Customer
Delete the information and metadata of the given user | key: deleteCustomer
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Customer string / Required customerId | 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 connection / Required connection | The connection to be used. | |
Order Id string / Required orderId | Provide the unique identifier of the order. | 34538345353 |
Delete Product
Delete the information and metadata of a given product | key: deleteProduct
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Product Id string / Required productId | Provide a unique identifier of the given product. | 453702037542 |
Delete Product Category
Delete Product Category | key: deleteProductCategory
| Input | Notes | Example |
|---|---|---|
Category Id string / Required categoryId | Provide a unique identifier of an existing category. | 16343654345325 |
Connection connection / Required connection | The connection to be used. |
Delete Refund
Delete the information and metadata of a refund | key: deleteRefund
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Order Id string / Required orderId | Provide the unique identifier of the order. | 34538345353 |
Refund Id string / Required refundId | Provide a unique identifier of an existing refund. | 16343654345325 |
Get Coupon Totals Report
Returns the information and metadata of a Coupon Totals Report | key: getCouponTotalsReport
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
End Date string maxDate | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Start Date string minDate | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Period string 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 connection / Required connection | The connection to be used. | |
Customer string / Required customerId | 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 connection / Required connection | The connection to be used. | |
End Date string maxDate | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Start Date string minDate | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Period string 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 connection / Required connection | The connection to be used. | |
Order Id string / Required orderId | Provide the unique identifier of the order. | 34538345353 |
Get Order Totals Report
Returns the information and metadata of a Order Totals Report | key: getOrderTotalsReport
| Input | Notes |
|---|---|
Connection connection / Required connection | The connection to be used. |
Get Product
Returns the information and metadata of a given product | key: getProduct
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Product Id string / Required productId | Provide a unique identifier of the given product. | 453702037542 |
Get Product Category
Returns the information and metadata of the product category | key: getProductCategory
| Input | Notes | Example |
|---|---|---|
Category Id string / Required categoryId | Provide a unique identifier of an existing category. | 16343654345325 |
Connection connection / Required connection | The connection to be used. |
Get Product Totals Report
Returns the information and metadata of a Product Totals Report | key: getProductTotalsReport
| Input | Notes |
|---|---|
Connection connection / Required connection | The connection to be used. |
Get Refund
Returns the information and metadata of a refund | key: getRefund
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Order Id string / Required orderId | Provide the unique identifier of the order. | 34538345353 |
Refund Id string / Required refundId | Provide a unique identifier of an existing refund. | 16343654345325 |
Get Review Totals Report
Returns the information and metadata of a Review Totals Report | key: getReviewTotalsReport
| Input | Notes |
|---|---|
Connection connection / Required connection | The connection to be used. |
Get Sales Report
Returns the information and metadata of a Sales Report | key: getSalesReport
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
End Date string maxDate | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Start Date string minDate | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Period string 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 connection / Required connection | The connection to be used. | |
End Date string maxDate | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Start Date string minDate | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | 2022-04-06 |
Period string 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 |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Page Offset string offset | Provide an integer for the page offset since the first page. | 5 |
Page Number string page | Provide an integer for the page number. | 5 |
Results Per Page string resultsPerPage | Provide an integer for the amount of items to be returned. | 100 |
Example Payload for List Customers
Example Payload for List Customers
{
"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 string after | Limit response to resources published after a given ISO8601 compliant date. | 2020-07-10 15:00:00.000 |
Before string before | Limit response to resources published before a given ISO8601 compliant date. | 2020-07-10 15:00:00.000 |
Connection connection / Required connection | The connection to be used. | |
Page Offset string offset | Provide an integer for the page offset since the first page. | 5 |
Page Number string page | Provide an integer for the page number. | 5 |
Results Per Page string resultsPerPage | Provide an integer for the amount of items to be returned. | 100 |
Search string search | Search for a specific string. | Search For This String |
Example Payload for List Orders
Example Payload for List Orders
{
"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 |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Page Offset string offset | Provide an integer for the page offset since the first page. | 5 |
Page Number string page | Provide an integer for the page number. | 5 |
Results Per Page string resultsPerPage | Provide an integer for the amount of items to be returned. | 100 |
List Products
Returns a list of all active products | key: listProducts
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Page Offset string offset | Provide an integer for the page offset since the first page. | 5 |
Page Number string page | Provide an integer for the page number. | 5 |
Results Per Page string resultsPerPage | Provide an integer for the amount of items to be returned. | 100 |
Example Payload for List Products
Example Payload for List Products
{
"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 string after | Limit response to resources published after a given ISO8601 compliant date. | 2020-07-10 15:00:00.000 |
Before string before | Limit response to resources published before a given ISO8601 compliant date. | 2020-07-10 15:00:00.000 |
Connection connection / Required connection | The connection to be used. | |
Page Offset string offset | Provide an integer for the page offset since the first page. | 5 |
Order Id string / Required orderId | Provide the unique identifier of the order. | 34538345353 |
Page Number string page | Provide an integer for the page number. | 5 |
Results Per Page string resultsPerPage | Provide an integer for the amount of items to be returned. | 100 |
Search string search | Search for a specific string. | Search For This String |
List Reports
Returns a list of all reports | key: listReports
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | The connection to be used. | |
Page Offset string offset | Provide an integer for the page offset since the first page. | 5 |
Page Number string page | Provide an integer for the page number. | 5 |
Results Per Page string resultsPerPage | Provide an integer for the amount of items to be returned. | 100 |
Raw Request
Send raw HTTP request to WooCommerce | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | The connection to be used. | ||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | 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 string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required 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 boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. |
Update Customer
Update an existing customer record | key: updateCustomer
| Input | Notes | Example |
|---|---|---|
Billing Address 1 string billingAddress1 | Provide a string value for the address 1 of the billing address. | 969 Market |
Billing Address 2 string billingAddress2 | Provide a string value for the address 2 of the billing address. | apt 2 |
Billing City string billingCity | Provide a string value for the city of the billing address. | San Francisco |
Billing Tigers string billingCountry | Provide a string value for the country of the billing address. | US |
Billing Postal Code string billingPostalCode | Provide a string value for the postal code of the billing address. | 94103 |
Billing State string billingState | Provide a string value for the state of the billing address. | CA |
Company string company | Provide a string value for the company name. | Acme Inc. |
Connection connection / Required connection | The connection to be used. | |
Customer string / Required customerId | Provide a unique identifier for the desired customer. This value should be an id | someone@example.com |
Email Address string email | Provide a valid email address. | someone@example.com |
First Name string firstName | Provide a string value for the first name. | John |
Last Name string lastName | Provide a string value for the last name. | Doe |
Phone string phone | Provide a string value for the phone number of the billing address. | (555) 555-5555 |
Shipping Address 1 string shippingAddress1 | Provide a string value for the address 1 of the shipping address. | 969 Market |
Shipping Address 2 string shippingAddress2 | Provide a string value for the address 2 of the shipping address. | apt 2 |
Shipping City string shippingCity | Provide a string value for the city of the billing address. | San Francisco |
Shipping Country string shippingCountry | Provide a string value for the country of the billing address. | US |
Shipping Postal Code string shippingPostalCode | Provide a string value for the postal code of the billing address. | 94103 |
Shipping State string shippingState | Provide a string value for the state of the billing address. | CA |
Username string username | Provide a string value for the username. | john.doe |
Update Product
Create a new product record | key: updateProduct
| Input | Notes | Example |
|---|---|---|
Categories code categories | For each item, provide an id of a category that the product belongs to. | |
Connection connection / Required connection | The connection to be used. | |
Description string description | Provide a description for the product. | This is an example description. |
Images code images | For each item, provide a link to the image stored in your | |
Price string price | Provide a number for the price of the product. | 21.99 |
Product Id string / Required productId | Provide a unique identifier of the given product. | 453702037542 |
Product Name string productName | Provide a string value for the name of the product. | Software Subscription |
Product Type string productType | Provide a string value for the name of the product. | simple |
Summary string summary | Provide a short summary for the product details. | This is an example short summary. |
Optional Values string Key Value List values | For each item, provide an optional key value pair to be injected into the request body. |