# SourceShopify


## Fields

| Field                                                                                                                                                            | Type                                                                                                                                                             | Required                                                                                                                                                         | Description                                                                                                                                                      | Example                                                                                                                                                          |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `shop`                                                                                                                                                           | *str*                                                                                                                                                            | :heavy_check_mark:                                                                                                                                               | 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' or 'NAME.myshopify.com'. | my-store                                                                                                                                                         |
| `bulk_window_in_days`                                                                                                                                            | *Optional[int]*                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                               | Defines what would be a date range per single BULK Job                                                                                                           |                                                                                                                                                                  |
| `credentials`                                                                                                                                                    | [Optional[models.ShopifyAuthorizationMethod]](../models/shopifyauthorizationmethod.md)                                                                           | :heavy_minus_sign:                                                                                                                                               | The authorization method to use to retrieve data from Shopify                                                                                                    |                                                                                                                                                                  |
| `fetch_transactions_user_id`                                                                                                                                     | *Optional[bool]*                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                               | Defines which API type (REST/BULK) to use to fetch `Transactions` data. If you are a `Shopify Plus` user, leave the default value to speed up the fetch.         |                                                                                                                                                                  |
| `job_checkpoint_interval`                                                                                                                                        | *Optional[int]*                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                               | The threshold, after which the single BULK Job should be checkpointed.                                                                                           |                                                                                                                                                                  |
| `job_product_variants_include_pres_prices`                                                                                                                       | *Optional[bool]*                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                               | If enabled, the `Product Variants` stream attempts to include `Presentment prices` field (may affect the performance).                                           |                                                                                                                                                                  |
| `job_termination_threshold`                                                                                                                                      | *Optional[int]*                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                               | The max time in seconds, after which the single BULK Job should be `CANCELED` and retried. The bigger the value the longer the BULK Job is allowed to run.       |                                                                                                                                                                  |
| `source_type`                                                                                                                                                    | [models.SourceShopifyShopify](../models/sourceshopifyshopify.md)                                                                                                 | :heavy_check_mark:                                                                                                                                               | N/A                                                                                                                                                              |                                                                                                                                                                  |
| `start_date`                                                                                                                                                     | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects)                                                                                     | :heavy_minus_sign:                                                                                                                                               | The date you would like to replicate data from. Format: YYYY-MM-DD. Any data before this date will not be replicated.                                            |                                                                                                                                                                  |