51 lines
2.5 KiB
Markdown
51 lines
2.5 KiB
Markdown
# Katana
|
|
This is the Katana source connector that ingests data from the katana API.
|
|
|
|
Katana is a real-time cloud inventory platform to manage sales channels, products, and materials to always be ready to meet demands. You can find more about it here https://katanamrp.com/
|
|
|
|
This source uses OAuth Bearer Token for authentication. In order to obtain your API token, you must first create an account on Katana and be on their Professional Plan.
|
|
|
|
To generate a live API key: log in to your Katana account. Go to Settings > API. Select Add new API key. You can find more about the API here https://developer.katanamrp.com/reference/api-introduction
|
|
|
|
## Configuration
|
|
|
|
| Input | Type | Description | Default Value |
|
|
|-------|------|-------------|---------------|
|
|
| `api_key` | `string` | API Key. API key to use. Find it at https://katanamrp.com/login/ | |
|
|
| `start_date` | `string` | Start date. | |
|
|
|
|
## Streams
|
|
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|
|
|-------------|-------------|------------|---------------------|----------------------|
|
|
| customers | id | DefaultPaginator | ✅ | ✅ |
|
|
| shipping_fee | | DefaultPaginator | ✅ | ❌ |
|
|
| costs | id | DefaultPaginator | ✅ | ✅ |
|
|
| customer_addresses | id | DefaultPaginator | ✅ | ✅ |
|
|
| variants | id | DefaultPaginator | ✅ | ✅ |
|
|
| tax_rates | id | DefaultPaginator | ✅ | ✅ |
|
|
| suppliers | id | DefaultPaginator | ✅ | ✅ |
|
|
| stocktakes | id | DefaultPaginator | ✅ | ✅ |
|
|
| stock_adjustments | id | DefaultPaginator | ✅ | ✅ |
|
|
| sales_orders | id | DefaultPaginator | ✅ | ✅ |
|
|
| sales_order_fulfillments | id | DefaultPaginator | ✅ | ❌ |
|
|
| sales_order_addresses | id | DefaultPaginator | ✅ | ✅ |
|
|
| recipes | ingredient_variant_id.product_variant_id | DefaultPaginator | ✅ | ✅ |
|
|
| purchase_orders | id | DefaultPaginator | ✅ | ✅ |
|
|
| products | id | DefaultPaginator | ✅ | ✅ |
|
|
| price_lists | id | DefaultPaginator | ✅ | ❌ |
|
|
| inventory | variant_id | DefaultPaginator | ✅ | ❌ |
|
|
| locations | id | DefaultPaginator | ✅ | ✅ |
|
|
| manufacturing_orders | id | DefaultPaginator | ✅ | ✅ |
|
|
| materials | id | DefaultPaginator | ✅ | ✅ |
|
|
|
|
## Changelog
|
|
|
|
<details>
|
|
<summary>Expand to review</summary>
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|------------------|-------------------|--------------|----------------|
|
|
| 0.0.1 | 2024-10-12 | | Initial release by [@aazam-gh](https://github.com/aazam-gh) via Connector Builder |
|
|
|
|
</details>
|