# WooCommerce

### Snapshot

| Features                        | Details                                                                                     |
| ------------------------------- | ------------------------------------------------------------------------------------------- |
| Release Status                  | Released                                                                                    |
| Source API Version              | V3                                                                                          |
| Table Selection                 | Yes                                                                                         |
| Column Selection                | Yes                                                                                         |
| Edit Integration                | Yes                                                                                         |
| Replication Type Selection      | No                                                                                          |
| Authentication Parameters       | <p>WordPress site-id/ Domain<br>WooCommerce Consumer key<br>WooCommerce Consumer secret</p> |
| Replication Type                | <p>Full Replication<br>Key Based Incremental</p>                                            |
| Replication Key                 | Date                                                                                        |
| Suggested Replication Frequency | 1 hour                                                                                      |

### Tables/APIs supported

<table data-header-hidden><thead><tr><th width="380">Tables/APIs Supported</th><th></th></tr></thead><tbody><tr><td>Coupons</td><td>Customers</td></tr><tr><td>Orders</td><td>Refunds</td></tr><tr><td>Products</td><td>Variations</td></tr><tr><td>Reviews</td><td></td></tr></tbody></table>

### Integrate WooCommerce with Daton

{% hint style="info" %}
You can use [Templates](https://daton-sarasanalytics.gitbook.io/daton/~/changes/1yNKwtXwaJMWImmUJtdv/platform/features/templates#what-are-templates)[ ](https://daton-sarasanalytics.gitbook.io/daton/~/changes/1yNKwtXwaJMWImmUJtdv/platform/features/templates#what-are-templates)to create new integrations quickly, this may help you in configuring your Tables, Fields, or Column selection with ease.
{% endhint %}

1. Sign in to Daton.
2. Select WooCommerce from the list of Integrations.
3. Provide Integration Name, Replication Frequency, and History. The integration name would be used in creating tables for the integration and cannot be changed later&#x20;
4. Provide site-id/domain, WooCommerce consumer key and consumer secret. Follow this [link](https://docs.sarasanalytics.com/faqs/api-keys/woocommerce-api-keys) for more information
5. Post successful authentication, you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### WooCommerce Data

#### **Coupons**

Purpose: This API is used to fetch all coupons that have been created&#x20;

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&#x20;

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    |

#### &#x20;**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    |


---

# Agent Instructions: 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:

```
GET https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/ecommerce/woocommerce.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.