From 7ae250deed14f4701e07d51dd931f15e62337fd5 Mon Sep 17 00:00:00 2001 From: Abhi Vaidyanatha Date: Wed, 20 Oct 2021 18:56:17 -0700 Subject: [PATCH] Fix WooCommerce source page. (#7228) --- docs/integrations/sources/woo-commerce.md | 50 ++++++++++++++++++++++- docs/integrations/sources/woocommerce.md | 50 ----------------------- 2 files changed, 49 insertions(+), 51 deletions(-) delete mode 100644 docs/integrations/sources/woocommerce.md diff --git a/docs/integrations/sources/woo-commerce.md b/docs/integrations/sources/woo-commerce.md index 27fb96eb99d59..4e97d0c065a1e 100644 --- a/docs/integrations/sources/woo-commerce.md +++ b/docs/integrations/sources/woo-commerce.md @@ -1,2 +1,50 @@ -# Woo Commerce +# WooCommerce +## Sync overview + +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. + +This source can sync data for the [WooCommerce API](https://woocommerce.github.io/woocommerce-rest-api-docs/). + +This Source Connector is based on a [Airbyte CDK](https://docs.airbyte.io/connector-development/cdk-python). + +### Output schema + +This Source is capable of syncing the following core Streams: + +* [Customers](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-customers) +* [Orders](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-orders) +* [Coupons](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-coupons) + +### Data type mapping + +| Integration Type | Airbyte Type | Notes | +| :--- | :--- | :--- | +| `string` | `string` | | +| `number` | `number` | | +| `array` | `array` | | +| `object` | `object` | | + +### Features + +| Feature | Supported?\(Yes/No\) | Notes | +| :--- | :--- | :--- | +| Full Refresh Sync | Yes | | +| Incremental - Append Sync | Yes | | +| Namespaces | No | | + +## Getting started + +1. Navigate to your store’s WordPress admin interface, go to (WooCommerce > Settings > Advanced > REST API) +2. Click on "Add Key" to generate an API Key +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. + * 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. +4. The two keys, Consumer Key and Consumer Secret are what you'll use respectively as `api_key` and `api_secret` for the integration. +5. You're ready to set up WooCommerce in Airbyte! + + +## Changelog + +| Version | Date | Pull Request | Subject | +| :------ | :-------- | :----- | :------ | +| 0.1.0 | 2021-09-09 | [5955](https://github.com/airbytehq/airbyte/pull/5955) | Initial Release. Source WooCommerce | diff --git a/docs/integrations/sources/woocommerce.md b/docs/integrations/sources/woocommerce.md deleted file mode 100644 index 4e97d0c065a1e..0000000000000 --- a/docs/integrations/sources/woocommerce.md +++ /dev/null @@ -1,50 +0,0 @@ -# WooCommerce - -## Sync overview - -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. - -This source can sync data for the [WooCommerce API](https://woocommerce.github.io/woocommerce-rest-api-docs/). - -This Source Connector is based on a [Airbyte CDK](https://docs.airbyte.io/connector-development/cdk-python). - -### Output schema - -This Source is capable of syncing the following core Streams: - -* [Customers](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-customers) -* [Orders](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-orders) -* [Coupons](https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-coupons) - -### Data type mapping - -| Integration Type | Airbyte Type | Notes | -| :--- | :--- | :--- | -| `string` | `string` | | -| `number` | `number` | | -| `array` | `array` | | -| `object` | `object` | | - -### Features - -| Feature | Supported?\(Yes/No\) | Notes | -| :--- | :--- | :--- | -| Full Refresh Sync | Yes | | -| Incremental - Append Sync | Yes | | -| Namespaces | No | | - -## Getting started - -1. Navigate to your store’s WordPress admin interface, go to (WooCommerce > Settings > Advanced > REST API) -2. Click on "Add Key" to generate an API Key -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. - * 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. -4. The two keys, Consumer Key and Consumer Secret are what you'll use respectively as `api_key` and `api_secret` for the integration. -5. You're ready to set up WooCommerce in Airbyte! - - -## Changelog - -| Version | Date | Pull Request | Subject | -| :------ | :-------- | :----- | :------ | -| 0.1.0 | 2021-09-09 | [5955](https://github.com/airbytehq/airbyte/pull/5955) | Initial Release. Source WooCommerce |