WooCommerce beta
Read your WooCommerce orders, products and other data from your store
by Dashkit
One-time download. No subscription.
This extension is currently in free beta. Note that the functionality can still be incomplete and that the tables can still change.
- Version 0.1.0
- Operating systems Linux & Mac (ARM)
This SQLite extension connects to your WooCommerce online store via REST API, allowing you to easily query your customers, orders, coupons, products, and other information with a live connection.
Key points
- Calls WooCommerce directly from your local machine
- Works with any SQLite program or programming language
- Uses read-only calls, throttled and safeguarded
- Fast in-memory cache with a five minute expiry
- One-time download, no subscription needed
- Lifetime updates
Tables 37
woo_category
All available product categories for the store
| Column | Type | Description |
|---|---|---|
| category_id | int | Category ID |
| parent_id | int | Parent ID |
| slug | text | Slug |
| name | text | Category name |
| display | text | Category archive display type |
| product_count | int | Number of published products |
| description | text | Category description |
| image_url | text | Image URL |
woo_coupon
All available coupons for the store
| Column | Type | Description |
|---|---|---|
| coupon_id | int | Coupon ID |
| code | text | Coupon code |
| description | text | Coupon description |
| discount_amount | real | Discount amount |
| discount_type | text | Discount type |
| expires_at | datetime | Coupon expiry time |
| usage_times | int | Number of times coupon has been used |
| usage_limit | int | Number of times coupon can be used |
| per_customer | int | Number of times coupon can be used per customer |
| min_amount | real | Minimum order amount required for coupon |
| max_amount | real | Maximum order amount allowed with coupon |
| max_items | int | Maximum cart items allowed for coupon |
| use_individually | bool | Whether can only be used individually |
| use_free_shipping | bool | Whether to enable free shipping |
| is_for_sale_items | bool | Whether to apply coupon to items with sale prices |
| product_ids | json | Product IDs coupon can only be used on |
| exclude_product_ids | json | Product IDs coupon cannot be used on |
| category_ids | json | Category IDs coupon can only be used on |
| exclude_category_ids | json | Category IDs coupon cannot be used on |
| emails | json | Emails allowed to use coupon |
| used_by | json | User IDs or emails that have used coupon |
| meta_data | json | Meta data |
| created_at | datetime | Created at |
| updated_at | datetime | Updated at |
woo_customer
All customers for the store
| Column | Type | Description |
|---|---|---|
| customer_id | int | Customer ID |
| text | ||
| username | text | Customer login name |
| first_name | text | First name |
| last_name | text | Last name |
| role | text | Customer role |
| is_paying | bool | Whether customer is paying |
| avatar_url | text | Avatar URL |
| meta_data | json | Meta data |
| created_at | datetime | Created at |
| updated_at | datetime | Updated at |
woo_customer_billing
Billing addresses for each customer
| Column | Type | Description |
|---|---|---|
| customer_id | int | Customer ID |
| first_name | text | First name |
| last_name | text | Last name |
| company | text | Company name |
| address_1 | text | Address line 1 |
| address_2 | text | Address line 2 |
| city | text | City name |
| state | text | ISO code or name of state, province or district |
| postal | text | Postal code |
| country | text | Country ISO 3166 code |
| text | ||
| phone | text | Phone |
woo_customer_download
Downloadable files and permissions for a customer. Note that customer_id
is needed to query this table.
| Column | Type | Description |
|---|---|---|
| customer_id | int | Customer ID |
| product_id | int | Product ID |
| order_id | int | Order ID |
| download_id | text | Download ID |
| name | text | Download name |
| downloads_left | int | Number of downloads remaining |
| expires_at | datetime | Download access expiry time |
| file_url | text | File URL |
| download_url | text | Download URL |
woo_customer_shipping
Shipping addresses for each customer
| Column | Type | Description |
|---|---|---|
| customer_id | int | Customer ID |
| first_name | text | First name |
| last_name | text | Last name |
| company | text | Company name |
| address_1 | text | Address line 1 |
| address_2 | text | Address line 2 |
| city | text | City name |
| state | text | ISO code or name of state, province or district |
| postal | text | Postal code |
| country | text | Shipping country ISO 3166 code |
| phone | text | Phone |
woo_order
All available orders for the store
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| parent_id | int | Parent ID |
| order_number | text | Order number |
| order_key | text | Order key |
| customer_id | int | Customer ID |
| status | text | Order status |
| created_via | text | Where order was created |
| currency | text | ISO 4217 currency code |
| total | real | Total |
| total_tax | real | Sum of all taxes |
| cart_tax | real | Sum of line item taxes only |
| tax_inclusive | bool | Whether prices included tax during checkout |
| shipping | real | Total shipping amount |
| shipping_tax | real | Total shipping tax amount |
| fees | real | Sum of fees after discounts |
| fees_tax | real | Sum of fees taxes only after discounts |
| discount | real | Total discount amount |
| discount_tax | real | Total discount tax amount |
| refunded | real | Total refunded amount |
| note | text | Note from customer |
| completed_at | datetime | Completed time |
| paid_at | datetime | Paid time |
| payment_method_id | text | Payment method ID |
| transaction_id | text | Transaction ID |
| ip_address | text | Customer IP address |
| user_agent | text | Customer browser user agent |
| store_version | text | Version of WooCommerce which last updated order |
| cart_hash | text | MD5 hash of cart items to ensure orders are not modified |
| meta_data | json | Meta data |
| created_at | datetime | Created at |
| updated_at | datetime | Updated at |
woo_order_billing
Billing addresses for each order
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| first_name | text | First name |
| last_name | text | Last name |
| company | text | Company name |
| address_1 | text | Address line 1 |
| address_2 | text | Address line 2 |
| city | text | City name |
| state | text | ISO code or name of state, province or district |
| postal | text | Postal code |
| country | text | Country ISO 3166 code |
| text | ||
| phone | text | Phone |
woo_order_coupon
Used coupons for each order
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| coupon_id | int | Coupon ID |
| code | text | Coupon code |
| discount | real | Discount total |
| discount_tax | real | Discount total tax |
woo_order_fee
Fees for each order
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| name | text | Fee name |
| tax_class | text | Tax class |
| tax_status | text | Tax status |
| total | real | Line total (after discounts) |
| total_tax | real | Line total tax (after discounts) |
woo_order_line
Order lines for each order
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| product_id | int | Product ID |
| variation_id | int | Variation ID |
| sku | text | Product SKU |
| name | text | Product name |
| price | real | Product price |
| quantity | int | Quantity ordered |
| tax_class | text | Tax class |
| subtotal | real | Line subtotal (before discounts) |
| subtotal_tax | real | Line subtotal tax (before discounts) |
| total | real | Line total (after discounts) |
| total_tax | real | Line total tax (after discounts) |
woo_order_note
Administrator and system notes for each order. Note that order_id
is needed to query this table.
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| note_id | int | Note ID |
| author_name | text | Author name |
| is_from_user | bool | Whether note is from user or system |
| is_for_customer | bool | Whether note is shown to customers and they are notified |
| note | text | Note content |
| created_at | datetime | Created at |
woo_order_shipping
Shipping addresses for each order
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| first_name | text | First name |
| last_name | text | Last name |
| company | text | Company name |
| address_1 | text | Address line 1 |
| address_2 | text | Address line 2 |
| city | text | City name |
| state | text | ISO code or name of state, province or district |
| postal | text | Postal code |
| country | text | Country ISO 3166 code |
| phone | text | Phone |
woo_order_shipping_method
Shipping method details for each order
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| shipping_method | text | Shipping method |
| name | text | Shipping method name |
| total | real | Line total (after discounts) |
| total_tax | real | Line total tax (after discounts) |
woo_order_tax
Tax information for each order
| Column | Type | Description |
|---|---|---|
| order_id | int | Order ID |
| tax_rate_id | int | Tax rate ID |
| code | text | Tax rate code |
| name | text | Tax rate name |
| total | real | Tax total exl. shipping taxes |
| shipping | real | Shipping tax total |
| is_compound | bool | Whether tax rate is a compound tax rate |
woo_payment_gateway
All available payment gateways for the store
| Column | Type | Description |
|---|---|---|
| payment_gateway_id | text | Payment gateway ID |
| name | text | Payment gateway name |
| is_enabled | bool | Whether payment gateway is enabled |
woo_product
All products for the store
| Column | Type | Description |
|---|---|---|
| product_id | int | Product ID |
| parent_id | int | Parent ID |
| sku | text | Product SKU |
| name | text | Product name |
| slug | text | Slug |
| type | text | Product type |
| status | text | Product status |
| visibility | text | Catalog visibility |
| can_purchase | bool | Whether product can be bought |
| is_featured | bool | Whether product is featured |
| is_virtual | bool | Whether product is virtual |
| is_download | bool | Whether product is downloadable |
| is_sold_separately | bool | Allow only one item per order |
| can_review | bool | Whether product allows reviews |
| rating_average | real | Average rating |
| rating_times | int | Rating times |
| category_ids | json | Category IDs |
| tag_ids | json | Tag IDs |
| variation_ids | json | Variation IDs |
| grouped_ids | json | Grouped product IDs |
| upsell_ids | json | Up-sell product IDs |
| cross_sell_ids | json | Cross-sell product IDs |
| related_ids | json | Related product IDs |
| product_url | text | Permalink product URL |
| external_url | text | External product URL |
| short_description | text | Short description |
| description | text | Product description |
| meta_data | json | Meta data |
| created_at | datetime | Created at |
| updated_at | datetime | Updated at |
woo_product_attribute
Attributes for each product
| Column | Type | Description |
|---|---|---|
| product_id | int | Product ID |
| name | text | Attribute name |
| use_as_variation | bool | Whether can be used as variation |
| is_visible | bool | Whether visible on product page |
| default_option | text | Default option |
| options | json | Available options |
woo_product_download
Downloadable files for each product
| Column | Type | Description |
|---|---|---|
| product_id | int | Product ID |
| name | text | Download name |
| download_limit | int | Number of times download is allowed after purchase |
| download_days | int | Number of days download is allowed after purchase |
| file_url | text | File URL |
woo_product_image
Images for each product
| Column | Type | Description |
|---|---|---|
| product_id | int | Product ID |
| name | text | Image name |
| alt_text | text | Alternative text |
| image_url | text | Image URL |
| created_at | datetime | Created at |
| updated_at | datetime | Updated at |
woo_product_price
Prices for each product
| Column | Type | Description |
|---|---|---|
| product_id | int | Product ID |
| regular_price | real | Regular price |
| sale_price | real | Sale price |
| price | real | Current price |
| is_on_sale | bool | Whether product is on sale |
| sale_starts_at | datetime | Start time of sale price |
| sale_ends_at | datetime | End time of sale price |
| sale_times | int | Number of sales |
| tax_class | text | Tax class |
| tax_status | text | Tax status |
| shipping_class_id | int | Shipping class ID |
| is_shipping_taxable | bool | Whether product shipping is taxable |
| is_shipping_required | bool | Whether product needs to be shipped |
| purchase_note | text | Note to send to customer after purchase |
woo_product_stock
Stock information for each product
| Column | Type | Description |
|---|---|---|
| product_id | int | Product ID |
| status | text | Stock status |
| quantity | int | Stock quantity |
| manage_stock | bool | Stock management at product level |
| backorders | text | Whether backorders are allowed |
| width | real | Width |
| height | real | Height |
| length | real | Length |
| weight | real | Weight |
| is_backordered | bool | Whether product is backordered |
woo_refund
All order refunds for the store
| Column | Type | Description |
|---|---|---|
| refund_id | int | Refund ID |
| order_id | int | Order ID |
| amount | real | Total refund amount |
| reason | text | Reason for refund |
| refunded_by | int | Refunded by user ID |
| is_api_refund | bool | Whether payment was refunded via API |
| meta_data | json | Meta data |
| created_at | datetime | Created at |
woo_report_sales
Summary of sales for given dates. Note that date is needed to query
this table. Date range is fetched in 90 day batches to retrieve daily
figures.
| Column | Type | Description |
|---|---|---|
| date | date | Sales date |
| customers | int | Number of customers |
| orders | int | Number of orders placed |
| items | int | Number of items purchased |
| sales | real | Gross sales |
| tax | real | Total charged for taxes |
| shipping | real | Total charged for shipping |
| discount | real | Total of coupons used |
woo_report_top_seller
Summary of top selling products for given dates. Note that date is needed to query this table. Date range is fetched one day at a time to retrieve daily figures.
| Column | Type | Description |
|---|---|---|
| date | date | Sales date |
| product_id | int | Product ID |
| product_name | text | Product name |
| quantity | int | Quantity of purchases |
woo_review
All product reviews for the store
| Column | Type | Description |
|---|---|---|
| review_id | int | Review ID |
| product_id | int | Product ID |
| status | text | Review status |
| reviewer_name | text | Reviewer name |
| reviewer_email | text | Reviewer email |
| rating | int | Review rating (0 to 5) |
| is_verified | bool | Whether reviewer bought the product |
| review | text | Review content |
| created_at | datetime | Created at |
woo_shipping_class
All product shipping classes for the store
| Column | Type | Description |
|---|---|---|
| shipping_class_id | int | Shipping class ID |
| slug | text | Slug |
| name | text | Shipping class name |
| product_count | int | Number of published products |
| description | text | Shipping class description |
woo_shipping_method
All shipping methods for the store
| Column | Type | Description |
|---|---|---|
| shipping_method | text | Shipping method |
| name | text | Shipping method name |
| description | text | Shipping method description |
woo_tag
All product tags for the store
| Column | Type | Description |
|---|---|---|
| tag_id | int | Tag ID |
| slug | text | Slug |
| name | text | Tag name |
| product_count | int | Number of published products |
| description | text | Tag description |
woo_tax_class
All tax classes for the store
| Column | Type | Description |
|---|---|---|
| tax_class | text | Tax class |
| name | text | Tax class name |
woo_tax_rate
All tax rates for the store
| Column | Type | Description |
|---|---|---|
| tax_rate_id | int | Tax rate ID |
| name | text | Tax rate name |
| class | text | Tax class |
| priority | int | Priority |
| rate | real | Rate |
| country | text | Country ISO 3166 code |
| state | text | State ISO code |
| city_names | json | City names |
| postal_codes | json | Postal codes |
| use_for_shipping | bool | Whether tax rate gets applied to shipping |
| is_compound | bool | Whether tax rate is a compound tax rate |
woo_variation
All product variations for the store. Note that product_id is needed
to query this table.
| Column | Type | Description |
|---|---|---|
| variation_id | int | Variation ID |
| product_id | int | Product ID |
| sku | text | Product SKU |
| status | text | Product status |
| can_purchase | bool | Whether product can be bought |
| is_virtual | bool | Whether product is virtual |
| is_download | bool | Whether product is downloadable |
| variation_url | text | Permalink variation URL |
| description | text | Variation description |
| meta_data | json | Meta data |
| created_at | datetime | Created at |
| updated_at | datetime | Updated at |
woo_variation_attribute
Attributes for each product variation. Note that product_id is needed
to query this table.
| Column | Type | Description |
|---|---|---|
| variation_id | int | Variation ID |
| product_id | int | Product ID |
| name | text | Attribute name |
| option | text | Selected option |
woo_variation_download
Downloadable files for each product variation. Note that product_id
is needed to query this table.
| Column | Type | Description |
|---|---|---|
| variation_id | int | Variation ID |
| product_id | int | Product ID |
| name | text | Download name |
| download_limit | int | Number of times to allow downloading after purchase |
| download_days | int | Number of days to allow downloading after purchase |
| file_url | text | File URL |
woo_variation_image
Images for each product variation. Note that product_id is needed
to query this table.
| Column | Type | Description |
|---|---|---|
| variation_id | int | Variation ID |
| product_id | int | Product ID |
| name | text | Image name |
| alt_text | text | Alternative text |
| image_url | text | Image URL |
| created_at | datetime | Created at |
| updated_at | datetime | Updated at |
woo_variation_price
Prices for each product variation. Note that product_id is needed
to query this table.
| Column | Type | Description |
|---|---|---|
| variation_id | int | Variation ID |
| product_id | int | Product ID |
| regular_price | real | Regular price |
| sale_price | real | Sale price |
| price | real | Current price |
| is_on_sale | bool | Whether product is on sale |
| sale_starts_at | datetime | Start time of sale price |
| sale_ends_at | datetime | End time of sale price |
| tax_class | text | Tax class |
| tax_status | text | Tax status |
| shipping_class_id | int | Shipping class ID |
woo_variation_stock
Stock information for each product variation. Note that product_id
is needed to query this table.
| Column | Type | Description |
|---|---|---|
| variation_id | int | Variation ID |
| product_id | int | Product ID |
| status | text | Stock status |
| quantity | int | Stock quantity |
| manage_stock | bool | Stock management at product level |
| backorders | text | Whether backorders are allowed |
| width | real | Width |
| height | real | Height |
| length | real | Length |
| weight | real | Weight |
| is_backordered | bool | Whether variation is backordered |
Configuration
Every new SQLite connection should call function
woo_config
with authentication details. This information is not saved,
and kept in-memory for the duration of the connection.
select woo_config( 'url: .., key: ..., secret: ...' );
- url URL to the WooCommerce store
- key Consumer key from WooCommerce
- secret Consumer secret from WooCommerce
-
prefix
Prefix for table names, defaults to
woo_
FAQ
For any questions, support, or feedback regarding this extension, please contact support
Why should I try this beta extension?
This extension is currently available for free to anyone who wants to try the WooCommerce extension. If you send your feedback to support, you will receive the personal version for free when it is released.
Which WooCommerce version do I need?
- WooCommerce 3.5+ with WordPress 4.4+
- Use of HTTPS protocol
- Enabled permalinks
Where do I find my WooCommerce credentials?
How quickly can I fetch WooCommerce data?
What other software do I need?
You will need either Linux or Mac (ARM) 64-bit operating system. Windows is currently not supported.
In addition, you should have SQLite version 3.45.1 or newer installed, with support for extensions.
How do I receive updates?
We will email you when an update to the same extension version has been released.