Shopify
The Shopify connector allows you to sync data from your Shopify store into Shaped.
Preparation
To allow Shaped to connect to your Shopify store, obtain an access token and provide your store ID.
- Log in to your Shopify admin panel.
- Navigate to Apps and select Develop apps.
- Click Create an app and follow the prompts to create a new private app.
- Go to Configuration and enable the required Admin API scopes for the data you want to sync.
- Once configured, retrieve the Access token to provide to Shaped.
- Note your Store ID, which is your Shopify store's domain (e.g.,
your-store.myshopify.com).
Dataset Configuration
Required fields
| Field | Example | Description |
|---|---|---|
| schema_type | SHOPIFY | Specifies the connector schema type, in this case "SHOPIFY". |
| access_token | shp_1234567890abcdef | Your Shopify API access token. |
| store_id | your-store.myshopify.com | Your Shopify store ID, typically in the format your-store.myshopify.com. |
| stream | orders | The Shopify API data stream to sync (e.g., orders, products, customers). |
Optional fields
| Field | Example | Description |
|---|---|---|
| is_plus_account | true | Set to true if using a Shopify Plus account, required to sync the users stream. |
| start_date | 2023-01-01T00:00:00Z | The start date for syncing data. If not provided, syncing starts from the earliest data. |
| admin_url | https://admin.shopify.com/store/your-store | Your Shopify admin URL if different from the default. |
| batch_size | 10000 | Number of records to fetch from the Shopify API in each batch. Default is 1000. |
| unique_keys | ["id"] | Specify a list of columns that uniquely identify a row in the table, if duplicate rows are inserted with these keys, the latest row will be used. |
| schedule_interval | @hourly | Schedule interval for syncing data. Default is @hourly. |
Dataset Creation Example
Below is an example of a Shopify dataset connector configuration:
name: your_shopify_dataset
schema_type: SHOPIFY
access_token: shp_1234567890abcdef
store_id: your-store.myshopify.com
stream: orders
The following payload will create a Shopify dataset and begin syncing data from Shaped using the Shaped CLI.
shaped create-dataset --file dataset.yaml