Skip to content

Latest commit

 

History

History
111 lines (82 loc) · 4.35 KB

source_shopify.md

File metadata and controls

111 lines (82 loc) · 4.35 KB
page_title subcategory description
airbyte_source_shopify Resource - terraform-provider-airbyte
SourceShopify Resource

airbyte_source_shopify (Resource)

SourceShopify Resource

Example Usage

resource "airbyte_source_shopify" "my_source_shopify" {
  configuration = {
    bulk_window_in_days = 4
    credentials = {
      api_password = {
        api_password = "...my_api_password..."
      }
      o_auth20 = {
        access_token  = "...my_access_token..."
        client_id     = "...my_client_id..."
        client_secret = "...my_client_secret..."
      }
    }
    fetch_transactions_user_id               = true
    job_checkpoint_interval                  = 484517
    job_product_variants_include_pres_prices = true
    job_termination_threshold                = 5282
    shop                                     = "my-store"
    start_date                               = "2021-05-19"
  }
  definition_id = "1a8f2c45-b7ec-4db1-8680-d2e228b3d43e"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "de6ea042-7883-4cc3-9786-89e9d969aa09"
}

Schema

Required

  • configuration (Attributes) (see below for nested schema)
  • name (String) Name of the source e.g. dev-mysql-instance.
  • workspace_id (String)

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
  • secret_id (String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • shop (String) 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'.

Optional:

  • bulk_window_in_days (Number) Defines what would be a date range per single BULK Job. Default: 30
  • credentials (Attributes) The authorization method to use to retrieve data from Shopify (see below for nested schema)
  • fetch_transactions_user_id (Boolean) 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. Default: false
  • job_checkpoint_interval (Number) The threshold, after which the single BULK Job should be checkpointed (min: 15k, max: 1M). Default: 100000
  • job_product_variants_include_pres_prices (Boolean) If enabled, the Product Variants stream attempts to include Presentment prices field (may affect the performance). Default: true
  • job_termination_threshold (Number) 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. Default: 7200
  • start_date (String) The date you would like to replicate data from. Format: YYYY-MM-DD. Any data before this date will not be replicated. Default: "2020-01-01"

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.api_password

Required:

  • api_password (String, Sensitive) The API Password for your private application in the Shopify store.

Nested Schema for configuration.credentials.o_auth20

Optional:

  • access_token (String, Sensitive) The Access Token for making authenticated requests.
  • client_id (String, Sensitive) The Client ID of the Shopify developer application.
  • client_secret (String, Sensitive) The Client Secret of the Shopify developer application.

Import

Import is supported using the following syntax:

terraform import airbyte_source_shopify.my_airbyte_source_shopify ""