WooCommerce

Provides integration with WooCommerce via the WooCommerce REST API.

Revision History

1.0.0.0 Initial release.
1.0.0.1 Added support for auth via query string parameters.

Properties

Connection

Type: Connection Input
The Connection Property, which defines the WooCommerce site URL, API credentials, and request options.

SiteUrl
Type: String
The base URL for your WooCommerce site, e.g. https://mywooshop.com.

IndexUrl
Type: String
The relative REST API path used by Flowgear to acquire metadata and generate the list of samples. Defaults to /wp-json/wc/v3.

ConsumerKey
Type: String
Used for authentication. See WooCommerce REST API Keys for instructions on how to generate credentials.

ConsumerSecret
Type: Secret
Used for authentication. See WooCommerce REST API Keys for instructions on how to generate credentials.

ReturnRestFailureResponses
Type: Boolean
When enabled, failures are returned in ResponseCode and Response instead of raised as Node errors. Defaults to true.

ExcludeEmptyQueryParameters
Type: Boolean
When enabled, empty custom Properties on the Node that would usually be expressed as query string parameters are ignored. Defaults to true.

AuthenticateUsingQueryStringParemeters
Type: Boolean
When enabled, authentication is passed in the query string instead of the Authorization header. Defaults to false. Enable this when your WooCommerce site won't accept authentication via headers.

OperationId

Type: String Input
Contains the ID of the operation chosen from a Node Sample. This Property should not be manually changed.

Description

Type: String Input
A generated description of the operation based on the OpenAPI document.

Request

Type: Multiline Text Input
Contains the request payload, usually JSON, for the selected operation. A sample value for this Property is populated when a Node Sample is selected.

ResponseCode

Type: String Output
Contains the response code returned from the API server. 200 indicates success.

Response

Type: Multiline Text Output
Contains the response payload, usually JSON, as received from the API. When ReturnRestFailureResponses is enabled, handled failure responses are returned here as well.

Custom Inputs

This Node supports Custom Input Properties. Path and query parameters are added when a Node Sample is selected. These Properties are resolved into parameters in the URL that is generated for the request. For example, if the operation queries a customer record, the OpenAPI document may specify the URL template as /customers/{customerId}. In this case, a custom Property called customerId is added to the Node when a Get Customer Node Sample is selected.

Remarks

Using Samples

This Node acquires metadata from the WooCommerce index API and generates Node Samples from the OpenAPI document returned by that API.

HTTPS Required

SiteUrl must begin with https://. The Node uses consumer-key authentication, which is not supported over HTTP. This is especially important when AuthenticateUsingQueryStringParemeters is enabled, because the ConsumerKey and ConsumerSecret are included in the request URL.

Date Parameters

When using the WooCommerce REST API after order parameter, provide an ISO 8601-compatible date, e.g. 2023-07-31 23:23:59. You must also supply the order and orderby parameters when using after.

Authentication Errors

Depending on the way your WooCommerce site is configured, it may not accept the default authentication model, where the key and secret are passed via the HTTPS Authorization header. If you receive authentication errors, verify that the site accepts the selected authentication mode and that the ConsumerKey and ConsumerSecret values are correct. Otherwise, enable the AuthenticateUsingQueryStringParemeters Property in the Connection.