Skip to main content

WooCommerce Component

Easily manage your customers, orders, and products in your WooCommerce platform

Component key: woo-commerce

Description#

Woo 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 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.

InputNotesExample
Input
Domain
string
/ Required
Notes
Provide a string value for the domain of your wordpress site.
Example
www.mySite.com
Input
Consumer Secret
password
/ Required
Notes
 
Example
 
Input
Consumer Key
string
/ Required
Notes
 
Example
 

Actions#

Create Customer#

Create a new customer record | key: createCustomer

InputNotesExample
Input
Billing Address 1
string
Notes
Provide a string value for the address 1 of the billing address.
Example
969 Market
Input
Billing Address 2
string
Notes
Provide a string value for the address 2 of the billing address.
Example
apt 2
Input
Billing City
string
Notes
Provide a string value for the city of the billing address.
Example
San Francisco
Input
Company
string
Notes
Provide a string value for the company name.
Example
Acme Inc.
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Country
string
Notes
Provide a string value for the country of the billing address.
Example
US
Input
Email Address
string
/ Required
Notes
Provide a valid email address.
Example
someone@example.com
Input
First Name
string
Notes
Provide a string value for the first name.
Example
John
Input
Last Name
string
Notes
Provide a string value for the last name.
Example
Doe
Input
Phone
string
Notes
Provide a string value for the phone number of the billing address.
Example
(555) 555-5555
Input
Postal Code
string
Notes
Provide a string value for the postal code of the billing address.
Example
94103
Input
Shipping Address 1
string
Notes
Provide a string value for the address 1 of the shipping address.
Example
969 Market
Input
Shipping Address 2
string
Notes
Provide a string value for the address 2 of the shipping address.
Example
apt 2
Input
Shipping City
string
Notes
Provide a string value for the city of the billing address.
Example
San Francisco
Input
Shipping Country
string
Notes
Provide a string value for the country of the billing address.
Example
US
Input
Shipping Postal Code
string
Notes
Provide a string value for the postal code of the billing address.
Example
94103
Input
Shipping State
string
Notes
Provide a string value for the state of the billing address.
Example
CA
Input
State
string
Notes
Provide a string value for the state of the billing address.
Example
CA
Input
Username
string
Notes
Provide a string value for the username.
Example
john.doe
Input
Optional Values
string
Key Value List
Notes
For each item, provide an optional key value pair to be injected into the request body.
Example
 

Create Order#

Create a new order record | key: createOrder

InputNotesExample
Input
Billing Address 1
string
Notes
Provide a string value for the address 1 of the billing address.
Example
969 Market
Input
Billing Address 2
string
Notes
Provide a string value for the address 2 of the billing address.
Example
apt 2
Input
Billing City
string
Notes
Provide a string value for the city of the billing address.
Example
San Francisco
Input
Billing Country
string
Notes
Provide a string value for the country of the billing address.
Example
US
Input
Billing Postal Code
string
Notes
Provide a string value for the postal code of the billing address.
Example
94103
Input
Billing State
string
Notes
Provide a string value for the state of the billing address.
Example
CA
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Email Address
string
Notes
Provide a valid email address.
Example
someone@example.com
Input
First Name
string
Notes
Provide a string value for the first name.
Example
John
Input
Is Paid
boolean
/ Required
Notes
Determines if the order has been paid for.
Example
 
Input
Last Name
string
Notes
Provide a string value for the last name.
Example
Doe
Input
Line Items
code
Notes
Provide a JSON array, with objects each specifying details of the line item.
Example
[  {    "product_id": 93,    "quantity": 2  },  {    "product_id": 22,    "variation_id": 23,    "quantity": 1  },]
Input
Payment Method Key
string
Notes
Provide the unique identifier of the payment method.
Example
bacs
Input
Payment Method Title
string
Notes
Provide the unique identifier of the payment method.
Example
bacs
Input
Phone
string
Notes
Provide a string value for the phone number of the billing address.
Example
(555) 555-5555
Input
Shipping Address 1
string
Notes
Provide a string value for the address 1 of the shipping address.
Example
969 Market
Input
Shipping Address 2
string
Notes
Provide a string value for the address 2 of the shipping address.
Example
apt 2
Input
Shipping City
string
Notes
Provide a string value for the city of the billing address.
Example
San Francisco
Input
Shipping Country
string
Notes
Provide a string value for the country of the billing address.
Example
US
Input
Shipping Lines
code
Notes
Provide a JSON array, with objects each specifying details
Example
[  {    "method_id": "flat_rate",    "method_title": "Flat Rate",    "total": "10.00"  },]
Input
Shipping Postal Code
string
Notes
Provide a string value for the postal code of the billing address.
Example
94103
Input
Shipping State
string
Notes
Provide a string value for the state of the billing address.
Example
CA
Input
Optional Values
string
Key Value List
Notes
For each item, provide an optional key value pair to be injected into the request body.
Example
 

Create Product#

Create a new product record | key: createProduct

InputNotesExample
Input
Categories
code
Notes
For each item, provide an id of a category that the product belongs to.
Example
[  {    "id": 9,  },  {    "id": 14,  },]
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Description
string
Notes
Provide a description for the product.
Example
This is an example description.
Input
Images
code
Notes
For each item, provide a link to the image stored in your
Example
[  {    "src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"  },  {    "src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"  }]
Input
Price
string
Notes
Provide a number for the price of the product.
Example
21.99
Input
Product Name
string
Notes
Provide a string value for the name of the product.
Example
Software Subscription
Input
Product Type
string
Notes
Provide a string value for the name of the product.
Example
simple
Input
Summary
string
Notes
Provide a short summary for the product details.
Example
This is an example short summary.
Input
Optional Values
string
Key Value List
Notes
For each item, provide an optional key value pair to be injected into the request body.
Example
 

Create Product Category#

Create a new product category record | key: createProductCategory

InputNotesExample
Input
Category Name
string
/ Required
Notes
Provide a name for the category.
Example
Example Category
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Description
string
Notes
Provide a description for the product.
Example
This is an example description.
Input
Image Link
string
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 Refund#

Create a refund on an existing order | key: createRefund

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Line Items
code
Notes
Provide a JSON array, with objects each specifying details of the line item.
Example

      [        {          "id": "111",          "refund_total": 10,          "refund_tax": [            {              "id" "222",              "refund_total": 20            }          ]        }      ]
Input
Order Id
string
/ Required
Notes
Provide the unique identifier of the order.
Example
34538345353
Input
Refund Amount
string
Notes
Provide a value for the refund amount.
Example
30

Delete Customer#

Delete the information and metadata of the given user | key: deleteCustomer

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Customer
string
/ Required
Notes
Provide a unique identifier for the desired customer. This value can either be a username, email, or id
Example
someone@example.com

Delete Order#

Delete the information and metadata of an order | key: deleteOrder

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Order Id
string
/ Required
Notes
Provide the unique identifier of the order.
Example
34538345353

Delete Product#

Delete the information and metadata of a given product | key: deleteProduct

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Product Id
string
/ Required
Notes
Provide a unique identifier of the given product.
Example
453702037542

Delete Product Category#

Delete Product Category | key: deleteProductCategory

InputNotesExample
Input
Category Id
string
/ Required
Notes
Provide a unique identifier of an existing category.
Example
16343654345325
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 

Delete Refund#

Delete the information and metadata of a refund | key: deleteRefund

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Order Id
string
/ Required
Notes
Provide the unique identifier of the order.
Example
34538345353
Input
Refund Id
string
/ Required
Notes
Provide a unique identifier of an existing refund.
Example
16343654345325

Get Coupon Totals Report#

Returns the information and metadata of a Coupon Totals Report | key: getCouponTotalsReport

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
End Date
string
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
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
Notes
Provide a value for the sales period. Default is today's date.
Example
 

Get Customer#

Returns the information and metadata of the given user | key: getCustomer

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Customer
string
/ Required
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 Report#

Returns the information and metadata of a Customer Totals Report | key: getCustomerTotalsReport

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
End Date
string
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
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
Notes
Provide a value for the sales period. Default is today's date.
Example
 

Get Order#

Returns the information and metadata of an order | key: getOrder

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Order Id
string
/ Required
Notes
Provide the unique identifier of the order.
Example
34538345353

Get Order Totals Report#

Returns the information and metadata of a Order Totals Report | key: getOrderTotalsReport

InputNotes
Input
Connection
connection
/ Required
Notes
The connection to be used.

Get Product#

Returns the information and metadata of a given product | key: getProduct

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Product Id
string
/ Required
Notes
Provide a unique identifier of the given product.
Example
453702037542

Get Product Category#

Returns the information and metadata of the product category | key: getProductCategory

InputNotesExample
Input
Category Id
string
/ Required
Notes
Provide a unique identifier of an existing category.
Example
16343654345325
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 

Get Product Totals Report#

Returns the information and metadata of a Product Totals Report | key: getProductTotalsReport

InputNotes
Input
Connection
connection
/ Required
Notes
The connection to be used.

Get Refund#

Returns the information and metadata of a refund | key: getRefund

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Order Id
string
/ Required
Notes
Provide the unique identifier of the order.
Example
34538345353
Input
Refund Id
string
/ Required
Notes
Provide a unique identifier of an existing refund.
Example
16343654345325

Get Review Totals Report#

Returns the information and metadata of a Review Totals Report | key: getReviewTotalsReport

InputNotes
Input
Connection
connection
/ Required
Notes
The connection to be used.

Get Sales Report#

Returns the information and metadata of a Sales Report | key: getSalesReport

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
End Date
string
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
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
Notes
Provide a value for the sales period. Default is today's date.
Example
 

Get Top Sellers Report#

Returns the information and metadata of a Sales Report | key: getTopSellersReport

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
End Date
string
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
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
Notes
Provide a value for the sales period. Default is today's date.
Example
 

List Customers#

Returns a list of all active customers | key: listCustomers

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Page Offset
string
Notes
Provide an integer for the page offset since the first page.
Example
5
Input
Page Number
string
Notes
Provide an integer for the page number.
Example
5
Input
Results Per Page
string
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 Orders#

Returns a list of all orders | key: listOrders

InputNotesExample
Input
After
string
Notes
Limit response to resources published after a given ISO8601 compliant date.
Example
2020-07-10 15:00:00.000
Input
Before
string
Notes
Limit response to resources published before a given ISO8601 compliant date.
Example
2020-07-10 15:00:00.000
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Page Offset
string
Notes
Provide an integer for the page offset since the first page.
Example
5
Input
Page Number
string
Notes
Provide an integer for the page number.
Example
5
Input
Results Per Page
string
Notes
Provide an integer for the amount of items to be returned.
Example
100
Input
Search
string
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 Categories#

Returns a list of all product categories | key: listProductCategories

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Page Offset
string
Notes
Provide an integer for the page offset since the first page.
Example
5
Input
Page Number
string
Notes
Provide an integer for the page number.
Example
5
Input
Results Per Page
string
Notes
Provide an integer for the amount of items to be returned.
Example
100

List Products#

Returns a list of all active products | key: listProducts

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Page Offset
string
Notes
Provide an integer for the page offset since the first page.
Example
5
Input
Page Number
string
Notes
Provide an integer for the page number.
Example
5
Input
Results Per Page
string
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 Refunds#

Returns a list of all refunds on an existing order | key: listRefunds

InputNotesExample
Input
After
string
Notes
Limit response to resources published after a given ISO8601 compliant date.
Example
2020-07-10 15:00:00.000
Input
Before
string
Notes
Limit response to resources published before a given ISO8601 compliant date.
Example
2020-07-10 15:00:00.000
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Page Offset
string
Notes
Provide an integer for the page offset since the first page.
Example
5
Input
Order Id
string
/ Required
Notes
Provide the unique identifier of the order.
Example
34538345353
Input
Page Number
string
Notes
Provide an integer for the page number.
Example
5
Input
Results Per Page
string
Notes
Provide an integer for the amount of items to be returned.
Example
100
Input
Search
string
Notes
Search for a specific string.
Example
Search For This String

List Reports#

Returns a list of all reports | key: listReports

InputNotesExample
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Page Offset
string
Notes
Provide an integer for the page offset since the first page.
Example
5
Input
Page Number
string
Notes
Provide an integer for the page number.
Example
5
Input
Results Per Page
string
Notes
Provide an integer for the amount of items to be returned.
Example
100

Raw Request#

Issue a raw HTTP request with the configured connection | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
The connection to be used.
Example
 
Input
Data
string
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
Default
 
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
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
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
Default
 
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
Default
 
Notes
 
Example
 
Input
Query Parameter
string
Key Value List
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
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
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
 
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
 
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Update Customer#

Update an existing customer record | key: updateCustomer

InputNotesExample
Input
Billing Address 1
string
Notes
Provide a string value for the address 1 of the billing address.
Example
969 Market
Input
Billing Address 2
string
Notes
Provide a string value for the address 2 of the billing address.
Example
apt 2
Input
Billing City
string
Notes
Provide a string value for the city of the billing address.
Example
San Francisco
Input
Billing Tigers
string
Notes
Provide a string value for the country of the billing address.
Example
US
Input
Billing Postal Code
string
Notes
Provide a string value for the postal code of the billing address.
Example
94103
Input
Billing State
string
Notes
Provide a string value for the state of the billing address.
Example
CA
Input
Company
string
Notes
Provide a string value for the company name.
Example
Acme Inc.
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Customer
string
/ Required
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
Notes
Provide a valid email address.
Example
someone@example.com
Input
First Name
string
Notes
Provide a string value for the first name.
Example
John
Input
Last Name
string
Notes
Provide a string value for the last name.
Example
Doe
Input
Phone
string
Notes
Provide a string value for the phone number of the billing address.
Example
(555) 555-5555
Input
Shipping Address 1
string
Notes
Provide a string value for the address 1 of the shipping address.
Example
969 Market
Input
Shipping Address 2
string
Notes
Provide a string value for the address 2 of the shipping address.
Example
apt 2
Input
Shipping City
string
Notes
Provide a string value for the city of the billing address.
Example
San Francisco
Input
Shipping Country
string
Notes
Provide a string value for the country of the billing address.
Example
US
Input
Shipping Postal Code
string
Notes
Provide a string value for the postal code of the billing address.
Example
94103
Input
Shipping State
string
Notes
Provide a string value for the state of the billing address.
Example
CA
Input
Username
string
Notes
Provide a string value for the username.
Example
john.doe

Update Product#

Create a new product record | key: updateProduct

InputNotesExample
Input
Categories
code
Notes
For each item, provide an id of a category that the product belongs to.
Example
[  {    "id": 9,  },  {    "id": 14,  },]
Input
Connection
connection
/ Required
Notes
The connection to be used.
Example
 
Input
Description
string
Notes
Provide a description for the product.
Example
This is an example description.
Input
Images
code
Notes
For each item, provide a link to the image stored in your
Example
[  {    "src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"  },  {    "src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"  }]
Input
Price
string
Notes
Provide a number for the price of the product.
Example
21.99
Input
Product Id
string
/ Required
Notes
Provide a unique identifier of the given product.
Example
453702037542
Input
Product Name
string
Notes
Provide a string value for the name of the product.
Example
Software Subscription
Input
Product Type
string
Notes
Provide a string value for the name of the product.
Example
simple
Input
Summary
string
Notes
Provide a short summary for the product details.
Example
This is an example short summary.
Input
Optional Values
string
Key Value List
Notes
For each item, provide an optional key value pair to be injected into the request body.
Example