# Shopify
[Shopify](https://www.shopify.com/) is a comprehensive e-commerce platform that enables individuals and businesses to create online stores.

ingestr supports Shopify as a source.

## URI format
The URI format for Shopify is as follows:

```plaintext
shopify://<shopify store URL>?api_key=token
```

URI parameters:
- `shopify store URI`: the URL of the Shopify store you'd like to connect to, e.g. `myawesomestore.myshopify.com`
- `api_key`: the API key used for authentication with the Shopify API

The URI is used to connect to the Shopify API for extracting data. More details on setting up Shopify integrations can be found [here](https://shopify.dev/docs/admin-api/getting-started).

## Setting up a Shopify Integration

Shopify requires a few steps to set up an integration, please follow the guide dltHub [has built here](https://dlthub.com/docs/dlt-ecosystem/verified-sources/shopify#setup-guide).

Once you complete the guide, you should have an API key and the store name to connect to. Let's say your API key is `shpkey_12345` and the store you'd like to connect to is `my-store`, here's a sample command that will copy the data from the Shopify store into a DuckDB database:

```sh
ingestr ingest --source-uri 'shopify://my-store.myshopify.com?api_key=shpkey_12345' --source-table 'orders' --dest-uri duckdb:///shopify.duckdb --dest-table 'dest.orders'
```

The result of this command will be a table in the `shopify.duckdb` database with JSON columns.

## Tables
Shopify source allows ingesting the following sources into separate tables:
| Table | PK | Inc Key | Inc Strategy | Details |
|-------|----|---------|--------------|---------|
| [orders](https://shopify.dev/api/admin-rest/2023-10/resources/order) | id | updated_at | merge | Retrieves Shopify order data including customer info, line items, and shipping details |
| [customers](https://shopify.dev/api/admin-rest/2023-10/resources/customer) | id | updated_at | merge | Retrieves Shopify customer data including contact info and order history |
| [discounts](https://shopify.dev/docs/api/admin-graphql/2024-07/queries/discountNodes) | id | updated_at | merge | Retrieves Shopify discount data using GraphQL API (use instead of deprecated price_rules) |
| [products](https://shopify.dev/api/admin-rest/2023-10/resources/product) | id | updated_at | merge | Retrieves Shopify product information including variants, images, and inventory |
| [inventory_items](https://shopify.dev/api/admin-rest/2023-10/resources/inventoryitem) | id | updated_at | merge | Retrieves Shopify inventory item details and stock levels |
| [transactions](https://shopify.dev/api/admin-rest/2023-10/resources/transaction) | id | id | merge | Retrieves Shopify transaction data for payments and refunds |
| [balance](https://shopify.dev/api/admin-rest/2023-10/resources/balance) | currency | - | merge | Retrieves Shopify balance information for financial tracking |
| [events](https://shopify.dev/api/admin-rest/2023-10/resources/event) | id | created_at |merge| Retrieves Shopify event data for audit trails and activity tracking |
| [price_rules](https://shopify.dev/api/admin-rest/2023-10/resources/pricerule) | id | updated_at | merge | **DEPRECATED** - Use `discounts` table instead |

Use these as `--source-table` parameter in the `ingestr ingest` command.