Schema Information
This subtopic provides a structured reference to assist you in working with Daton's WooCommerce connector and the associated fields and tables.
Schema Information
This subtopic provides a structured reference to assist you in working with Daton's WooCommerce connector and the associated fields and tables.
Tables/APIs
The following is the list of tables or APIs associated with the WooCommerce connector:
- Coupons
- Customers
- Orders
- Refunds
- Products
- Variations
- Reviews
Coupons
Purpose: This API is used to fetch all coupons that have been created
Source API Documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-coupons
Replication: Key Based Incremental
Replication Key: modified_after, modified_before
Fields
Name |
Data Type |
|---|---|
id |
NUMERIC |
code |
STRING |
amount |
STRING |
status |
STRING |
date_created |
DATETIME |
date_created_gmt |
DATETIME |
date_modified |
DATETIME |
date_modified_gmt |
DATETIME |
discount_type |
STRING |
description |
STRING |
usage_count |
NUMERIC |
individual_use |
BOOLEAN |
free_shipping |
BOOLEAN |
exclude_sale_items |
BOOLEAN |
minimum_amount |
STRING |
maximum_amount |
STRING |
_links |
RECORD |
Customers
Purpose: This API is used to fetch all customers
Source API Documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-customers
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
|---|---|
id |
NUMERIC |
date_created |
DATETIME |
date_created_gmt |
DATETIME |
date_modified |
DATETIME |
date_modified_gmt |
DATETIME |
email |
STRING |
first_name |
STRING |
last_name |
STRING |
role |
STRING |
username |
STRING |
billing |
RECORD |
shipping |
RECORD |
is_paying_customer |
BOOLEAN |
avatar_url |
STRING |
meta_data |
RECORD |
_links |
RECORD |
Orders
Purpose: This API is to fetch all the orders
Source API Documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-orders
Replication: Key Based Incremental
Replication Key: modified_after, modified_before
Fields
Name |
Data Type |
|---|---|
id |
NUMERIC |
parent_id |
NUMERIC |
status |
STRING |
currency |
STRING |
version |
STRING |
prices_include_tax |
BOOLEAN |
date_created |
DATETIME |
date_modified |
DATETIME |
discount_total |
STRING |
discount_tax |
STRING |
shipping_total |
STRING |
shipping_tax |
STRING |
cart_tax |
STRING |
total |
STRING |
total_tax |
STRING |
customer_id |
NUMERIC |
order_key |
STRING |
billing |
RECORD |
shipping |
RECORD |
payment_method |
STRING |
payment_method_title |
STRING |
transaction_id |
STRING |
customer_ip_address |
STRING |
customer_user_agent |
STRING |
created_via |
STRING |
customer_note |
STRING |
date_completed |
DATETIME |
date_paid |
DATETIME |
cart_hash |
STRING |
number |
STRING |
meta_data |
RECORD |
line_items |
RECORD |
shipping_lines |
RECORD |
payment_url |
STRING |
date_created_gmt |
DATETIME |
date_modified_gmt |
DATETIME |
date_completed_gmt |
DATETIME |
date_paid_gmt |
DATETIME |
currency_symbol |
STRING |
_links |
RECORD |
Refunds
Purpose: This API is used to get the list of all the refunds from an order.
Source API Documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-refunds
Replication: Key Based Incremental
Replication Key: modified_after, modified_before
Fields
Name |
Data Type |
|---|---|
id |
NUMERIC |
order_id |
STRING |
date_created |
DATETIME |
date_created_gmt |
DATETIME |
amount |
STRING |
reason |
STRING |
refunded_by |
NUMERIC |
refunded_payment |
BOOLEAN |
line_items |
RECORD |
_links |
RECORD |
Products
Purpose: This API is used to get the list of all products.
Source API Documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#products
Replication: Key Based Incremental
Replication Key: modified_after, modified_before
Fields
Name |
Data Type |
|---|---|
id |
NUMERIC |
name |
STRING |
slug |
STRING |
permalink |
STRING |
date_created |
DATETIME |
date_created_gmt |
DATETIME |
date_modified |
DATETIME |
date_modified_gmt |
DATETIME |
type |
STRING |
status |
STRING |
featured |
BOOLEAN |
catalog_visibility |
STRING |
description |
STRING |
short_description |
STRING |
sku |
STRING |
price |
STRING |
regular_price |
STRING |
sale_price |
STRING |
on_sale |
BOOLEAN |
purchasable |
BOOLEAN |
total_sales |
NUMERIC |
virtual |
BOOLEAN |
downloadable |
BOOLEAN |
download_limit |
NUMERIC |
download_expiry |
NUMERIC |
external_url |
STRING |
button_text |
STRING |
tax_status |
STRING |
tax_class |
STRING |
manage_stock |
BOOLEAN |
backorders |
STRING |
backorders_allowed |
BOOLEAN |
backordered |
BOOLEAN |
sold_individually |
BOOLEAN |
weight |
STRING |
dimensions |
RECORD |
shipping_required |
BOOLEAN |
shipping_taxable |
BOOLEAN |
shipping_class |
STRING |
shipping_class_id |
NUMERIC |
reviews_allowed |
BOOLEAN |
average_rating |
STRING |
rating_count |
NUMERIC |
parent_id |
NUMERIC |
purchase_note |
STRING |
categories |
RECORD |
tags |
RECORD |
images |
RECORD |
attributes |
RECORD |
menu_order |
NUMERIC |
price_html |
STRING |
related_ids |
STRING |
meta_data |
RECORD |
stock_status |
STRING |
has_options |
BOOLEAN |
yoast_head |
STRING |
yoast_head_json |
RECORD |
_links |
RECORD |
Variations
Purpose: This API returns the list of all product variations
Source API Documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-product-variations
Replication: Key Based Incremental
Replication Key: modified_after, modified_before
Fields
Name |
Data Type |
|---|---|
id |
NUMERIC |
product_id |
STRING |
date_created |
DATETIME |
date_created_gmt |
DATETIME |
date_modified |
DATETIME |
date_modified_gmt |
DATETIME |
description |
STRING |
permalink |
STRING |
sku |
STRING |
price |
STRING |
regular_price |
STRING |
sale_price |
STRING |
on_sale |
BOOLEAN |
status |
STRING |
purchasable |
BOOLEAN |
virtual |
BOOLEAN |
downloadable |
BOOLEAN |
download_limit |
NUMERIC |
download_expiry |
NUMERIC |
tax_status |
STRING |
tax_class |
STRING |
manage_stock |
BOOLEAN |
stock_status |
STRING |
backorders |
STRING |
backorders_allowed |
BOOLEAN |
backordered |
BOOLEAN |
weight |
STRING |
dimensions |
RECORD |
shipping_class |
STRING |
shipping_class_id |
NUMERIC |
image |
RECORD |
attributes |
RECORD |
menu_order |
NUMERIC |
_links |
RECORD |
Reviews
Purpose: This API returns the list of all product reviews.
Source API Documentation https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-product-reviews
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
|---|---|
id |
NUMERIC |
date_created |
DATETIME |
date_created_gmt |
DATETIME |
product_id |
NUMERIC |
status |
STRING |
reviewer |
STRING |
reviewer_email |
STRING |
review |
STRING |
rating |
NUMERIC |
verified |
BOOLEAN |
reviewer_avatar_urls |
RECORD |
_links |
RECORD |