About the WooCommerce category

anon99371720 · September 21, 2022, 9:57am

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: WooCommerce API Reference

Connector package documentation

1. Setting up HTTP Client WooCommerce

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select WooCommerce Client as the HTTP Client.
Fill in the Base URI, Consumer Key, and Consumer Secret.
(For more information, see WooCommerce Authentication Reference
You can optionally enable logging of requests to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from WooCommerce

2.1 Steps

Go to Connections → Incoming, create a new incoming configuration, and select WooCommerce Subscriber as the subscriber.
Select the entity you want to subscribe to from WooCommerce.
Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you will request from WooCommerce.
Select the WooCommerce HTTP Client to use.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow WooCommerce documentation on building this connector, so you can easily use the connector based on WooCommerce API Reference.

HTTP Client

The HTTP Client configuration you will use to access WooCommerce.

Entity

The entity you want to subscribe to WooCommerce. Please refer to the entities from the WooCommerce API Reference page.

Request Parameters

You can provide these parameters to get the needed entity based on the WooCommerce API Reference.

Please look at the example below on how to fill the path field when subscribing “Retrieve a coupon” entity.

Based on the documentation, we can see that the endpoint requires “id” as a path. That is why we set the “id” inside the path key in the Request Parameters.

Path is the path parameter of the url. For example, the <id>.
Query is a defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

Alumio will then make a request to WooCommerce with the URL /wp-json/wc/v3/coupons/719

3. Publishing Entity to WooCommerce

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select WooCommerce Publisher as the publisher.
Select the Action the publisher wants to perform with the data.
Select the WooCommerce entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). However, you can also add or modify the payload using the Request Transformer.

Action

Currently, we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method) on submitting data to WooCommerce.

Entity

We support publishing to most WooCommerce endpoints.
Please refer to the WooCommerce API Reference page.

For example, we want to delete a coupon. Please select “Delete” as the Action and “Delete a Coupon by id” as the entity of the publisher.

Based on the documentation, we can see that the endpoint requires “id” as a path. That is why we set the “id” inside the path key in the data. Based on the documentation, it also requires a query of force in true if we want to delete the coupon permanently. So, we add the force data in query key inside our data.

Alumio will send an API request to WooCommerce with URL
/wp-json/wc/v3/coupons/719?force=true

Path is the path parameter of the url. For example, the <id>.
Query is a defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.