Skip to main content

WooCommerce Component

WooCommerce

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.

Actions​

Create Customer​

Create a new customer record | key: createCustomer

Create Order​

Create a new order record | key: createOrder

Create Product​

Create a new product record | key: createProduct

Create Product Category​

Create a new product category record | key: createProductCategory

Create Refund​

Create a refund on an existing order | key: createRefund

Delete Customer​

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

Delete Order​

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

Delete Product​

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

Delete Product Category​

Delete Product Category | key: deleteProductCategory

Delete Refund​

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

Get Coupon Totals Report​

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

Get Customer​

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

Get Customer Totals Report​

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

Get Order​

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

Get Order Totals Report​

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

Get Product​

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

Get Product Category​

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

Get Product Totals Report​

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

Get Refund​

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

Get Review Totals Report​

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

Get Sales Report​

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

Get Top Sellers Report​

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

List Customers​

Returns a list of all active customers | key: listCustomers

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

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

List Products​

Returns a list of all active products | key: listProducts

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

List Reports​

Returns a list of all reports | key: listReports

Raw Request​

Send a raw HTTP request to WooCommerce API | key: rawRequest

Update Customer​

Update an existing customer record | key: updateCustomer

Update Product​

Create a new product record | key: updateProduct