Skip to content

Commit

Permalink
Fix WooCommerce source page. (#7228)
Browse files Browse the repository at this point in the history
  • Loading branch information
avaidyanatha committed Oct 21, 2021
1 parent 58d81b2 commit 7ae250d
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 51 deletions.
50 changes: 49 additions & 1 deletion 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 |
50 changes: 0 additions & 50 deletions docs/integrations/sources/woocommerce.md

This file was deleted.

0 comments on commit 7ae250d

Please sign in to comment.