WooCommerce Component

Easily manage your customers, orders, and products in your WooCommerce platform
Component key: woo-commerce#
DescriptionWoo Commerce 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.
#
WooCommerce Connections#
WooCommerce Basic AuthWooCommerce 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 |
---|---|---|
Input Domain string / Required domain | Notes Provide a string value for the domain of your wordpress site. | Example www.mySite.com |
Input Consumer Secret password / Required password | Notes | Example |
Input Consumer Key string / Required username | Notes | Example |
#
Actions#
Create CustomerCreate a new customer record | key: createCustomer
Input | Notes | Example |
---|---|---|
Input Billing Address 1 string billingAddress1 | Notes Provide a string value for the address 1 of the billing address. | Example 969 Market |
Input Billing Address 2 string billingAddress2 | Notes Provide a string value for the address 2 of the billing address. | Example apt 2 |
Input Billing City string city | Notes Provide a string value for the city of the billing address. | Example San Francisco |
Input Company string company | Notes Provide a string value for the company name. | Example Acme Inc. |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Country string country | Notes Provide a string value for the country of the billing address. | Example US |
Input Email Address string / Required email | Notes Provide a valid email address. | Example someone@example.com |
Input First Name string firstName | Notes Provide a string value for the first name. | Example John |
Input Last Name string lastName | Notes Provide a string value for the last name. | Example Doe |
Input Phone string phone | Notes Provide a string value for the phone number of the billing address. | Example (555) 555-5555 |
Input Postal Code string postalcode | Notes Provide a string value for the postal code of the billing address. | Example 94103 |
Input Shipping Address 1 string shippingAddress1 | Notes Provide a string value for the address 1 of the shipping address. | Example 969 Market |
Input Shipping Address 2 string shippingAddress2 | Notes Provide a string value for the address 2 of the shipping address. | Example apt 2 |
Input Shipping City string shippingCity | Notes Provide a string value for the city of the billing address. | Example San Francisco |
Input Shipping Country string shippingCountry | Notes Provide a string value for the country of the billing address. | Example US |
Input Shipping Postal Code string shippingPostalCode | Notes Provide a string value for the postal code of the billing address. | Example 94103 |
Input Shipping State string shippingState | Notes Provide a string value for the state of the billing address. | Example CA |
Input State string state | Notes Provide a string value for the state of the billing address. | Example CA |
Input Username string username | Notes Provide a string value for the username. | Example john.doe |
Input Optional Values string Key Value List values | Notes For each item, provide an optional key value pair to be injected into the request body. | Example |
#
Create OrderCreate a new order record | key: createOrder
Input | Notes | Example |
---|---|---|
Input Billing Address 1 string billingAddress1 | Notes Provide a string value for the address 1 of the billing address. | Example 969 Market |
Input Billing Address 2 string billingAddress2 | Notes Provide a string value for the address 2 of the billing address. | Example apt 2 |
Input Billing City string billingCity | Notes Provide a string value for the city of the billing address. | Example San Francisco |
Input Billing Country string billingCountry | Notes Provide a string value for the country of the billing address. | Example US |
Input Billing Postal Code string billingPostalCode | Notes Provide a string value for the postal code of the billing address. | Example 94103 |
Input Billing State string billingState | Notes Provide a string value for the state of the billing address. | Example CA |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Email Address string email | Notes Provide a valid email address. | Example someone@example.com |
Input First Name string firstName | Notes Provide a string value for the first name. | Example John |
Input Is Paid boolean / Required isPaid | Notes Determines if the order has been paid for. | Example |
Input Last Name string lastName | Notes Provide a string value for the last name. | Example Doe |
Input Line Items code lineItems | Notes Provide a JSON array, with objects each specifying details of the line item. | Example
|
Input Payment Method Key string paymentMethod | Notes Provide the unique identifier of the payment method. | Example bacs |
Input Payment Method Title string paymentMethodTitle | Notes Provide the unique identifier of the payment method. | Example bacs |
Input Phone string phone | Notes Provide a string value for the phone number of the billing address. | Example (555) 555-5555 |
Input Shipping Address 1 string shippingAddress1 | Notes Provide a string value for the address 1 of the shipping address. | Example 969 Market |
Input Shipping Address 2 string shippingAddress2 | Notes Provide a string value for the address 2 of the shipping address. | Example apt 2 |
Input Shipping City string shippingCity | Notes Provide a string value for the city of the billing address. | Example San Francisco |
Input Shipping Country string shippingCountry | Notes Provide a string value for the country of the billing address. | Example US |
Input Shipping Lines code shippingLines | Notes Provide a JSON array, with objects each specifying details | Example
|
Input Shipping Postal Code string shippingPostalCode | Notes Provide a string value for the postal code of the billing address. | Example 94103 |
Input Shipping State string shippingState | Notes Provide a string value for the state of the billing address. | Example CA |
Input Optional Values string Key Value List values | Notes For each item, provide an optional key value pair to be injected into the request body. | Example |
#
Create ProductCreate a new product record | key: createProduct
Input | Notes | Example |
---|---|---|
Input Categories code categories | Notes For each item, provide an id of a category that the product belongs to. | Example
|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Description string description | Notes Provide a description for the product. | Example This is an example description. |
Input Images code images | Notes For each item, provide a link to the image stored in your | Example
|
Input Price string price | Notes Provide a number for the price of the product. | Example 21.99 |
Input Product Name string productName | Notes Provide a string value for the name of the product. | Example Software Subscription |
Input Product Type string productType | Notes Provide a string value for the name of the product. | Example simple |
Input Summary string summary | Notes Provide a short summary for the product details. | Example This is an example short summary. |
Input Optional Values string Key Value List values | Notes For each item, provide an optional key value pair to be injected into the request body. | Example |
#
Create Product CategoryCreate a new product category record | key: createProductCategory
Input | Notes | Example |
---|---|---|
Input Category Name string / Required categoryName | Notes Provide a name for the category. | Example Example Category |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Description string description | Notes Provide a description for the product. | Example This is an example description. |
Input Image Link string imageLink | Notes Provide a link to an image to represent your category. | Example http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg |
#
Create RefundCreate a refund on an existing order | key: createRefund
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Line Items code lineItems | Notes Provide a JSON array, with objects each specifying details of the line item. | Example
|
Input Order Id string / Required orderId | Notes Provide the unique identifier of the order. | Example 34538345353 |
Input Refund Amount string refundAmount | Notes Provide a value for the refund amount. | Example 30 |
#
Delete CustomerDelete the information and metadata of the given user | key: deleteCustomer
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Customer string / Required customerId | Notes Provide a unique identifier for the desired customer. This value can either be a username, email, or id | Example someone@example.com |
#
Delete OrderDelete the information and metadata of an order | key: deleteOrder
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Order Id string / Required orderId | Notes Provide the unique identifier of the order. | Example 34538345353 |
#
Delete ProductDelete the information and metadata of a given product | key: deleteProduct
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Product Id string / Required productId | Notes Provide a unique identifier of the given product. | Example 453702037542 |
#
Delete Product CategoryDelete Product Category | key: deleteProductCategory
Input | Notes | Example |
---|---|---|
Input Category Id string / Required categoryId | Notes Provide a unique identifier of an existing category. | Example 16343654345325 |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
#
Delete RefundDelete the information and metadata of a refund | key: deleteRefund
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Order Id string / Required orderId | Notes Provide the unique identifier of the order. | Example 34538345353 |
Input Refund Id string / Required refundId | Notes Provide a unique identifier of an existing refund. | Example 16343654345325 |
#
Get Coupon Totals ReportReturns the information and metadata of a Coupon Totals Report | key: getCouponTotalsReport
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input End Date string maxDate | Notes Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Start Date string minDate | Notes Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Period string period | Notes Provide a value for the sales period. Default is today's date. | Example |
#
Get CustomerReturns the information and metadata of the given user | key: getCustomer
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Customer string / Required customerId | Notes Provide a unique identifier for the desired customer. This value can either be a username, email, or id | Example someone@example.com |
#
Get Customer Totals ReportReturns the information and metadata of a Customer Totals Report | key: getCustomerTotalsReport
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input End Date string maxDate | Notes Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Start Date string minDate | Notes Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Period string period | Notes Provide a value for the sales period. Default is today's date. | Example |
#
Get OrderReturns the information and metadata of an order | key: getOrder
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Order Id string / Required orderId | Notes Provide the unique identifier of the order. | Example 34538345353 |
#
Get Order Totals ReportReturns the information and metadata of a Order Totals Report | key: getOrderTotalsReport
Input | Notes |
---|---|
Input Connection connection / Required connection | Notes The connection to be used. |
#
Get ProductReturns the information and metadata of a given product | key: getProduct
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Product Id string / Required productId | Notes Provide a unique identifier of the given product. | Example 453702037542 |
#
Get Product CategoryReturns the information and metadata of the product category | key: getProductCategory
Input | Notes | Example |
---|---|---|
Input Category Id string / Required categoryId | Notes Provide a unique identifier of an existing category. | Example 16343654345325 |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
#
Get Product Totals ReportReturns the information and metadata of a Product Totals Report | key: getProductTotalsReport
Input | Notes |
---|---|
Input Connection connection / Required connection | Notes The connection to be used. |
#
Get RefundReturns the information and metadata of a refund | key: getRefund
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Order Id string / Required orderId | Notes Provide the unique identifier of the order. | Example 34538345353 |
Input Refund Id string / Required refundId | Notes Provide a unique identifier of an existing refund. | Example 16343654345325 |
#
Get Review Totals ReportReturns the information and metadata of a Review Totals Report | key: getReviewTotalsReport
Input | Notes |
---|---|
Input Connection connection / Required connection | Notes The connection to be used. |
#
Get Sales ReportReturns the information and metadata of a Sales Report | key: getSalesReport
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input End Date string maxDate | Notes Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Start Date string minDate | Notes Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Period string period | Notes Provide a value for the sales period. Default is today's date. | Example |
#
Get Top Sellers ReportReturns the information and metadata of a Sales Report | key: getTopSellersReport
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input End Date string maxDate | Notes Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Start Date string minDate | Notes Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. | Example 2022-04-06 |
Input Period string period | Notes Provide a value for the sales period. Default is today's date. | Example |
#
List CustomersReturns a list of all active customers | key: listCustomers
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Page Offset string offset | Notes Provide an integer for the page offset since the first page. | Example 5 |
Input Page Number string page | Notes Provide an integer for the page number. | Example 5 |
Input Results Per Page string resultsPerPage | Notes Provide an integer for the amount of items to be returned. | Example 100 |
#
Output Example Payload{ "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 OrdersReturns a list of all orders | key: listOrders
Input | Notes | Example |
---|---|---|
Input After string after | Notes Limit response to resources published after a given ISO8601 compliant date. | Example 2020-07-10 15:00:00.000 |
Input Before string before | Notes Limit response to resources published before a given ISO8601 compliant date. | Example 2020-07-10 15:00:00.000 |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Page Offset string offset | Notes Provide an integer for the page offset since the first page. | Example 5 |
Input Page Number string page | Notes Provide an integer for the page number. | Example 5 |
Input Results Per Page string resultsPerPage | Notes Provide an integer for the amount of items to be returned. | Example 100 |
Input Search string search | Notes Search for a specific string. | Example Search For This String |
#
Output Example Payload{ "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 CategoriesReturns a list of all product categories | key: listProductCategories
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Page Offset string offset | Notes Provide an integer for the page offset since the first page. | Example 5 |
Input Page Number string page | Notes Provide an integer for the page number. | Example 5 |
Input Results Per Page string resultsPerPage | Notes Provide an integer for the amount of items to be returned. | Example 100 |
#
List ProductsReturns a list of all active products | key: listProducts
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Page Offset string offset | Notes Provide an integer for the page offset since the first page. | Example 5 |
Input Page Number string page | Notes Provide an integer for the page number. | Example 5 |
Input Results Per Page string resultsPerPage | Notes Provide an integer for the amount of items to be returned. | Example 100 |
#
Output Example Payload{ "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 RefundsReturns a list of all refunds on an existing order | key: listRefunds
Input | Notes | Example |
---|---|---|
Input After string after | Notes Limit response to resources published after a given ISO8601 compliant date. | Example 2020-07-10 15:00:00.000 |
Input Before string before | Notes Limit response to resources published before a given ISO8601 compliant date. | Example 2020-07-10 15:00:00.000 |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Page Offset string offset | Notes Provide an integer for the page offset since the first page. | Example 5 |
Input Order Id string / Required orderId | Notes Provide the unique identifier of the order. | Example 34538345353 |
Input Page Number string page | Notes Provide an integer for the page number. | Example 5 |
Input Results Per Page string resultsPerPage | Notes Provide an integer for the amount of items to be returned. | Example 100 |
Input Search string search | Notes Search for a specific string. | Example Search For This String |
#
List ReportsReturns a list of all reports | key: listReports
Input | Notes | Example |
---|---|---|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Page Offset string offset | Notes Provide an integer for the page offset since the first page. | Example 5 |
Input Page Number string page | Notes Provide an integer for the page number. | Example 5 |
Input Results Per Page string resultsPerPage | Notes Provide an integer for the amount of items to be returned. | Example 100 |
#
Raw RequestIssue a raw HTTP request with the configured connection | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required connection | Default | Notes The connection to be used. | Example |
Input Data string data | Default | Notes The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step. | Example {"exampleKey": "Example Data"} |
Input Debug Request boolean debugRequest | Default | Notes Enabling this flag will log out the current request. | Example |
Input File Data string Key Value List fileData | Default | Notes File Data to be sent as a multipart form upload. | Example [{key: "example.txt", value: "My File Contents"}] |
Input Form Data string Key Value List formData | Default | Notes The Form Data to be sent as a multipart form upload. | Example [{"key": "Example Key", "value": new Buffer("Hello World")}] |
Input Header string Key Value List headers | Default | Notes A list of headers to send with the request. | Example User-Agent: curl/7.64.1 |
Input Max Retry Count string maxRetries | Default 0 | Notes The maximum number of retries to attempt. | Example |
Input Method string method | Default | Notes | Example |
Input Query Parameter string Key Value List queryParams | Default | Notes 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. | Example |
Input Response Type string responseType | Default json | Notes The type of data you expect in the response. You can request json, text, or binary data. | Example binary |
Input Retry Delay (ms) string retryDelayMS | Default 0 | Notes The delay in milliseconds between retries. | Example |
Input Retry On All Errors boolean retryOnAllErrors | Default false | Notes If true, retries on all erroneous responses regardless of type. | Example |
Input Timeout string timeout | Default | Notes The maximum time that a client will await a response to its request | Example 2000 |
Input URL string / Required url | Default | Notes This is the URL to call. | Example /sobjects/Account |
Input Use Exponential Backoff boolean useExponentialBackoff | Default false | Notes Specifies whether to use a pre-defined exponential backoff strategy for retries. | Example |
#
Update CustomerUpdate an existing customer record | key: updateCustomer
Input | Notes | Example |
---|---|---|
Input Billing Address 1 string billingAddress1 | Notes Provide a string value for the address 1 of the billing address. | Example 969 Market |
Input Billing Address 2 string billingAddress2 | Notes Provide a string value for the address 2 of the billing address. | Example apt 2 |
Input Billing City string billingCity | Notes Provide a string value for the city of the billing address. | Example San Francisco |
Input Billing Tigers string billingCountry | Notes Provide a string value for the country of the billing address. | Example US |
Input Billing Postal Code string billingPostalCode | Notes Provide a string value for the postal code of the billing address. | Example 94103 |
Input Billing State string billingState | Notes Provide a string value for the state of the billing address. | Example CA |
Input Company string company | Notes Provide a string value for the company name. | Example Acme Inc. |
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Customer string / Required customerId | Notes Provide a unique identifier for the desired customer. This value can either be a username, email, or id | Example someone@example.com |
Input Email Address string email | Notes Provide a valid email address. | Example someone@example.com |
Input First Name string firstName | Notes Provide a string value for the first name. | Example John |
Input Last Name string lastName | Notes Provide a string value for the last name. | Example Doe |
Input Phone string phone | Notes Provide a string value for the phone number of the billing address. | Example (555) 555-5555 |
Input Shipping Address 1 string shippingAddress1 | Notes Provide a string value for the address 1 of the shipping address. | Example 969 Market |
Input Shipping Address 2 string shippingAddress2 | Notes Provide a string value for the address 2 of the shipping address. | Example apt 2 |
Input Shipping City string shippingCity | Notes Provide a string value for the city of the billing address. | Example San Francisco |
Input Shipping Country string shippingCountry | Notes Provide a string value for the country of the billing address. | Example US |
Input Shipping Postal Code string shippingPostalCode | Notes Provide a string value for the postal code of the billing address. | Example 94103 |
Input Shipping State string shippingState | Notes Provide a string value for the state of the billing address. | Example CA |
Input Username string username | Notes Provide a string value for the username. | Example john.doe |
#
Update ProductCreate a new product record | key: updateProduct
Input | Notes | Example |
---|---|---|
Input Categories code categories | Notes For each item, provide an id of a category that the product belongs to. | Example
|
Input Connection connection / Required connection | Notes The connection to be used. | Example |
Input Description string description | Notes Provide a description for the product. | Example This is an example description. |
Input Images code images | Notes For each item, provide a link to the image stored in your | Example
|
Input Price string price | Notes Provide a number for the price of the product. | Example 21.99 |
Input Product Id string / Required productId | Notes Provide a unique identifier of the given product. | Example 453702037542 |
Input Product Name string productName | Notes Provide a string value for the name of the product. | Example Software Subscription |
Input Product Type string productType | Notes Provide a string value for the name of the product. | Example simple |
Input Summary string summary | Notes Provide a short summary for the product details. | Example This is an example short summary. |
Input Optional Values string Key Value List values | Notes For each item, provide an optional key value pair to be injected into the request body. | Example |