You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: airbyte-integrations/connectors/source-shopify/source_shopify/spec.json
+11-8
Original file line number
Diff line number
Diff line change
@@ -10,18 +10,13 @@
10
10
"shop": {
11
11
"type": "string",
12
12
"title": "Shopify Store",
13
-
"description": "The name of the shopify store. For https://EXAMPLE.myshopify.com, the shop name is 'EXAMPLE'."
14
-
},
15
-
"start_date": {
16
-
"type": "string",
17
-
"title": "Start Date",
18
-
"description": "The date you would like to replicate data from. Format: YYYY-MM-DD. Any data before this date will not be replicated.",
19
-
"examples": ["2021-01-01"],
20
-
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
13
+
"description": "The name of your Shopify store found in the URL. For example, if your URL was https://NAME.myshopify.com, then the name would be 'NAME'.",
14
+
"order": 1
21
15
},
22
16
"credentials": {
23
17
"title": "Shopify Authorization Method",
24
18
"type": "object",
19
+
"order": 2,
25
20
"oneOf": [
26
21
{
27
22
"type": "object",
@@ -76,6 +71,14 @@
76
71
}
77
72
}
78
73
]
74
+
},
75
+
"start_date": {
76
+
"type": "string",
77
+
"title": "Start Date",
78
+
"description": "The date you would like to replicate data from. Format: YYYY-MM-DD. Any data before this date will not be replicated.",
Copy file name to clipboardExpand all lines: docs/integrations/sources/shopify.md
+59-60
Original file line number
Diff line number
Diff line change
@@ -13,71 +13,24 @@ This source can sync data for the [Shopify API](https://help.shopify.com/en/api/
13
13
14
14
This Source Connector is based on a [Airbyte CDK](https://docs.airbyte.io/connector-development/cdk-python).
15
15
16
-
## Troubleshooting
17
-
18
-
Check out common troubleshooting issues for the BigQuery destination connector on our Discourse [here](https://discuss.airbyte.io/tags/c/connector/11/source-shopify).
19
-
20
-
### Output schema
21
-
22
-
This Source is capable of syncing the following core Streams:
For better experience with `Incremental Refresh` the following is recommended:
49
-
50
-
*`Order Refunds`, `Order Risks`, `Transactions` should be synced along with `Orders` stream.
51
-
*`Discount Codes` should be synced along with `Price Rules` stream.
52
-
53
-
If child streams are synced alone from the parent stream - the full sync will take place, and the records are filtered out afterwards.
54
-
55
16
### Data type mapping
56
17
57
-
| Integration Type | Airbyte Type | Notes |
58
-
| :--- | :--- | :--- |
59
-
|`string`|`string`||
60
-
|`number`|`number`||
61
-
|`array`|`array`||
62
-
|`object`|`object`||
18
+
| Integration Type | Airbyte Type |
19
+
| :--- | :--- |
20
+
|`string`|`string`|
21
+
|`number`|`number`|
22
+
|`array`|`array`|
23
+
|`object`|`object`|
24
+
|`boolean`|`boolean`|
63
25
64
26
### Features
65
27
66
-
| Feature | Supported?\(Yes/No\)| Notes |
67
-
| :--- | :--- | :--- |
68
-
| Full Refresh Sync | Yes ||
69
-
| Incremental - Append Sync | Yes ||
70
-
| Namespaces | No ||
71
-
72
-
### Performance considerations
73
-
74
-
Shopify has some [rate limit restrictions](https://shopify.dev/concepts/about-apis/rate-limits). Typically, there should not be issues with throttling or exceeding the rate limits but in some edge cases, user can receive the warning message as follows:
28
+
| Feature | Supported?\(Yes/No\)|
29
+
| :--- | :--- |
30
+
| Full Refresh Sync | Yes |
31
+
| Incremental - Append Sync | Yes |
32
+
| Namespaces | No |
75
33
76
-
```text
77
-
"Caught retryable error '<some_error> or null' after <some_number> tries. Waiting <some_number> seconds then retrying..."
78
-
```
79
-
80
-
This is expected when the connector hits the 429 - Rate Limit Exceeded HTTP Error. With given error message the sync operation is still goes on, but will require more time to finish.
81
34
82
35
## Getting started
83
36
@@ -98,11 +51,57 @@ This connector support both: `OAuth 2.0` and `API PASSWORD` (for private applica
98
51
2. Proceed the authentication using your credentials for your Shopify account.
99
52
100
53
54
+
### Output Streams Schemas
55
+
56
+
This Source is capable of syncing the following core Streams:
For better experience with `Incremental Refresh` the following is recommended:
83
+
84
+
*`Order Refunds`, `Order Risks`, `Transactions` should be synced along with `Orders` stream.
85
+
*`Discount Codes` should be synced along with `Price Rules` stream.
86
+
87
+
If child streams are synced alone from the parent stream - the full sync will take place, and the records are filtered out afterwards.
88
+
89
+
### Performance considerations
90
+
91
+
Shopify has some [rate limit restrictions](https://shopify.dev/concepts/about-apis/rate-limits). Typically, there should not be issues with throttling or exceeding the rate limits but in some edge cases, user can receive the warning message as follows:
92
+
93
+
```text
94
+
"Caught retryable error '<some_error> or null' after <some_number> tries. Waiting <some_number> seconds then retrying..."
95
+
```
96
+
97
+
This is expected when the connector hits the 429 - Rate Limit Exceeded HTTP Error. With given error message the sync operation is still goes on, but will require more time to finish.
98
+
101
99
## Changelog
102
100
103
101
| Version | Date | Pull Request | Subject |
104
102
| :--- | :--- | :--- | :--- |
105
-
| 0.1.33 | 2022-02-17 |[10419](https://github.com/airbytehq/airbyte/pull/10419)| Fixed wrong field type for tax_exemptions |
103
+
| 0.1.34 | 2022-03-02 |[10794](https://github.com/airbytehq/airbyte/pull/10794)| Minor specification re-order, fixed links in documentation |
104
+
| 0.1.33 | 2022-02-17 |[10419](https://github.com/airbytehq/airbyte/pull/10419)| Fixed wrong field type for tax_exemptions for `Abandoned_checkouts` stream |
0 commit comments