Skip to content

Commit 7ae250d

Browse files
authored
Fix WooCommerce source page. (#7228)
1 parent 58d81b2 commit 7ae250d

File tree

2 files changed

+49
-51
lines changed

2 files changed

+49
-51
lines changed
+49-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
# Woo Commerce
1+
# WooCommerce
22

3+
## Sync overview
4+
5+
The WooCommerce source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.
6+
7+
This source can sync data for the [WooCommerce API](https://woocommerce.github.io/woocommerce-rest-api-docs/).
8+
9+
This Source Connector is based on a [Airbyte CDK](https://docs.airbyte.io/connector-development/cdk-python).
10+
11+
### Output schema
12+
13+
This Source is capable of syncing the following core Streams:
14+
15+
* [Customers](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-customers)
16+
* [Orders](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-orders)
17+
* [Coupons](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-coupons)
18+
19+
### Data type mapping
20+
21+
| Integration Type | Airbyte Type | Notes |
22+
| :--- | :--- | :--- |
23+
| `string` | `string` | |
24+
| `number` | `number` | |
25+
| `array` | `array` | |
26+
| `object` | `object` | |
27+
28+
### Features
29+
30+
| Feature | Supported?\(Yes/No\) | Notes |
31+
| :--- | :--- | :--- |
32+
| Full Refresh Sync | Yes | |
33+
| Incremental - Append Sync | Yes | |
34+
| Namespaces | No | |
35+
36+
## Getting started
37+
38+
1. Navigate to your store’s WordPress admin interface, go to (WooCommerce > Settings > Advanced > REST API)
39+
2. Click on "Add Key" to generate an API Key
40+
3. Choose the level of access for this REST API key, which can be Read access, Write access or Read/Write access. Airbyte only needs read-level access.
41+
* Note: The UI will show all possible data sources and will show errors when syncing if it doesn't have permissions to access a resource.
42+
4. The two keys, Consumer Key and Consumer Secret are what you'll use respectively as `api_key` and `api_secret` for the integration.
43+
5. You're ready to set up WooCommerce in Airbyte!
44+
45+
46+
## Changelog
47+
48+
| Version | Date | Pull Request | Subject |
49+
| :------ | :-------- | :----- | :------ |
50+
| 0.1.0 | 2021-09-09 | [5955](https://github.com/airbytehq/airbyte/pull/5955) | Initial Release. Source WooCommerce |

docs/integrations/sources/woocommerce.md

-50
This file was deleted.

0 commit comments

Comments
 (0)