ePrivacy and GPDR Cookie Consent by Cookie Consent Skip to main content

Connector WooCommerce

WooCommerce is a popular open-source WordPress plugin designed for e-commerce websites, enabling businesses to create and manage online stores with ease. In the context of integrating WooCommerce with a CDP, WooCommerce's API is particularly useful, especially its Orders endpoint. With this endpoint, businesses can extract important data about customer transactions, order details, and product information. The component extracting data from the WooCommerce API acts as a bridge, facilitating the smooth flow of information between the e-commerce platform and the CDP, ultimately empowering businesses to make data-driven decisions and optimize their marketing efforts.

Prerequisites

The application requires setting up Consumer Key and Consumer Secret in WooCommerce, as well as component configuration. 

Learn more about how to set Consumer Key and Consumer Secret in WooCommerce.

Data In/Data Out

Data In 

N/A

Data Out

Output files are in NDJSON format, where each line contains a row with information about the order. Output directory is data/out/files.

Learn more about the folder structure please go to this article.

Parameters

Consumer Key (required) To set it refer to WooCommerce documentation.
Consumer Secret (required) To set it refer to WooCommerce documentation.
Store URL (required) Link to the e-commerce store where the data is extracted from.
Orders
Start time (required)

Define the time range for orders.

  • Data type: string - timestamp in human-readable format (natural language). Example: now - 14 days12 hours ago
  • Data type: date time Example: yyyy-mm-dd hh:mm:ss
End time (required)

Define the time range for orders.

  • Data type: string - timestamp in human-readable format (natural language). Example: now -14 days12 hours ago
  • Data type: date time Example: yyyy-mm-dd hh:mm:ss

Example:

For orders created after 2022-05-12 12:35:00 until now,  set start= 2022-05-12 12:35:00 and end = now. The component results with:

1. Orders' start time:2022-05-12 12:35:00

2 Orders' end time: 2022-05-12 17:45:13

Remember: The timestamps you use for filtering should match WooCommerce site timezone, i.e. they are not interpreted in UTC or MI server timezone. The timestamps in the filter are compared specifically to order’s the date_created field.

Learn more: for date-time definition the parsedatetime library is used, specifically the parseDT() method. Examples for both human and standardized input can be found in tests, examples, and notes.