> For the complete documentation index, see [llms.txt](https://docs.coupler.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coupler.io/sources/category/ecommerce/woocommerce/data-overview.md). # Data Overview Coupler.io gives you access to a wide range of WooCommerce data — from transactional records like orders and line items to aggregated reports and store configuration. Here's a breakdown of what's available and how to use it. ## Entities and reports | Type | Entities | | ------------------ | ------------------------------------------------------------------------------------------------------------- | | Transactional | Orders, Orders with line items, Customers, Coupons, Product reviews | | Catalog | Products, Product categories, Product attributes, Product tags, Product shipping classes | | Aggregated reports | Sales report, Top sellers report, Order totals, Product totals, Customer totals, Coupon totals, Review totals | | Reference / Config | Currencies, Countries, Continents, Shipping zones, Tax classes, Tax rates | ## Metrics and dimensions #### Orders | Field | Description | | ---------------------- | --------------------------------------------------- | | id | Unique order ID | | status | Order status (pending, processing, completed, etc.) | | currency | Currency code used for the order | | date\_created | Date and time the order was placed | | date\_modified | Date and time the order was last updated | | total | Order grand total | | subtotal | Order subtotal before discounts and tax | | total\_tax | Total tax amount | | discount\_total | Total discount applied | | shipping\_total | Shipping cost | | payment\_method\_title | Payment method label | | customer\_id | ID of the customer (0 for guests) | | billing / shipping | Address fields for billing and shipping | #### Orders with line items This entity expands each order into one row per product, making it ideal for product-level sales analysis. | Field | Description | | ----------------------- | ------------------------- | | order\_id | Parent order ID | | line\_item\_name | Product name in the order | | line\_item\_quantity | Quantity ordered | | line\_item\_total | Line item total price | | line\_item\_sku | Product SKU | | line\_item\_product\_id | Product ID | #### Products | Field | Description | | ------------------------------------ | --------------------------------------- | | id | Product ID | | name | Product name | | sku | Stock keeping unit | | price / regular\_price / sale\_price | Pricing fields | | stock\_quantity | Current stock level | | stock\_status | In stock, out of stock, or on backorder | | categories | Assigned category names | | tags | Assigned tag names | | date\_created / date\_modified | Timestamps | | status | Published, draft, private, etc. | #### Customers | Field | Description | | ------------------------ | ----------------------------- | | id | Customer ID | | email | Email address | | first\_name / last\_name | Name fields | | date\_created | Account creation date | | orders\_count | Total number of orders placed | | total\_spent | Lifetime value | | billing / shipping | Address details | #### Coupons | Field | Description | | -------------- | ------------------------------------- | | id | Coupon ID | | code | Coupon code | | discount\_type | Percent, fixed cart, or fixed product | | amount | Discount value | | usage\_count | Times the coupon has been used | | usage\_limit | Maximum allowed uses | | date\_expires | Expiry date | #### Report: Sales report | Field | Description | | --------------- | ----------------------------------- | | total\_sales | Gross sales for the period | | net\_revenue | Revenue after refunds and discounts | | average\_sales | Average order value | | total\_orders | Number of orders | | total\_items | Total items sold | | total\_discount | Total discounts applied | | total\_refunds | Total refunded amount | | total\_tax | Total tax collected | | total\_shipping | Total shipping collected | #### Report: Top sellers report | Field | Description | | ----------- | ------------------------ | | name | Product name | | product\_id | Product ID | | quantity | Units sold in the period | ## Common metric combinations * **Orders + Customers** (Join on `customer_id`) — analyze lifetime value and order frequency per customer * **Orders with line items + Products** (Join on `product_id`) — enrich line item data with current stock and pricing * **Report: Sales report** filtered by period — track revenue trends week-over-week or month-over-month * **Coupons + Report: Coupon totals** — compare coupon configuration against actual usage performance ## Use cases by role {% tabs %} {% tab title="Store owners" %} * Monitor daily and monthly revenue using the **Sales report** entity in Google Sheets or Looker Studio * Track which products are driving the most sales with the **Top sellers report** * Feed order and revenue data into **ChatGPT or Claude** to generate automated store performance summaries {% endtab %} {% tab title="Marketing teams" %} * Analyze coupon campaign performance by combining **Coupons** and **Report: Coupon totals** * Segment customers by `total_spent` or `orders_count` from the **Customers** entity to identify high-value segments * Use **Product reviews** data to surface sentiment trends and identify products with low ratings {% endtab %} {% tab title="Operations / Finance" %} * Use **Orders with line items** to reconcile revenue by product and category * Pull **Tax rates** and order tax fields into BigQuery for finance reporting * Monitor stock levels with the **Products** entity and alert on low `stock_quantity` values {% endtab %} {% endtabs %} ## Platform-specific notes * **Product variations** are not a separate entity — variation-level data is nested within the Products response. Coupler.io does not currently expand variations into individual rows. * **WooCommerce Subscriptions** is a separate plugin; subscription-specific data is not available through the standard WooCommerce REST API. * **Custom fields / meta fields** added by third-party plugins are not included in standard entity exports. * The **Search** filter performs an exact match only — partial or fuzzy searches will not return results. * Date filters (After date / Before date) apply to `date_created` on the server side. They are available for Orders, Orders with line items, Products, Product reviews, and Coupons. * The **Sales report** and **Top sellers report** entities support period selection (Today, This Week, This Month, Last Month, This Year, or Custom with a date picker). * Stores using Cloudflare or other web application firewalls may need to whitelist Coupler.io to allow API requests through. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.coupler.io/sources/category/ecommerce/woocommerce/data-overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.