airbyte 0.8.0-beta2, Mar 27 25

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbyte.SourceShopify

Explore with Pulumi AI

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceShopify;
import com.pulumi.airbyte.SourceShopifyArgs;
import com.pulumi.airbyte.inputs.SourceShopifyConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceShopifyConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceShopifyConfigurationCredentialsApiPasswordArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceShopify = new SourceShopify("mySourceShopify", SourceShopifyArgs.builder()
            .configuration(SourceShopifyConfigurationArgs.builder()
                .bulk_window_in_days(4)
                .credentials(SourceShopifyConfigurationCredentialsArgs.builder()
                    .apiPassword(SourceShopifyConfigurationCredentialsApiPasswordArgs.builder()
                        .apiPassword("...my_api_password...")
                        .build())
                    .build())
                .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")
                .build())
            .definitionId("1a8f2c45-b7ec-4db1-8680-d2e228b3d43e")
            .secretId("...my_secret_id...")
            .workspaceId("de6ea042-7883-4cc3-9786-89e9d969aa09")
            .build());

    }
}

resources:
  mySourceShopify:
    type: airbyte:SourceShopify
    properties:
      configuration:
        bulk_window_in_days: 4
        credentials:
          apiPassword:
            apiPassword: '...my_api_password...'
        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
      definitionId: 1a8f2c45-b7ec-4db1-8680-d2e228b3d43e
      secretId: '...my_secret_id...'
      workspaceId: de6ea042-7883-4cc3-9786-89e9d969aa09

Create SourceShopify Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceShopify(name: string, args: SourceShopifyArgs, opts?: CustomResourceOptions);

@overload
def SourceShopify(resource_name: str,
                  args: SourceShopifyArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SourceShopify(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceShopifyConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)

func NewSourceShopify(ctx *Context, name string, args SourceShopifyArgs, opts ...ResourceOption) (*SourceShopify, error)

public SourceShopify(string name, SourceShopifyArgs args, CustomResourceOptions? opts = null)

public SourceShopify(String name, SourceShopifyArgs args)
public SourceShopify(String name, SourceShopifyArgs args, CustomResourceOptions options)

type: airbyte:SourceShopify
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceShopifyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceShopifyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceShopifyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceShopifyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceShopifyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceShopifyResource = new Airbyte.SourceShopify("sourceShopifyResource", new()
{
    Configuration = new Airbyte.Inputs.SourceShopifyConfigurationArgs
    {
        Shop = "string",
        BulkWindowInDays = 0,
        Credentials = new Airbyte.Inputs.SourceShopifyConfigurationCredentialsArgs
        {
            ApiPassword = new Airbyte.Inputs.SourceShopifyConfigurationCredentialsApiPasswordArgs
            {
                ApiPassword = "string",
            },
            OAuth20 = new Airbyte.Inputs.SourceShopifyConfigurationCredentialsOAuth20Args
            {
                AccessToken = "string",
                ClientId = "string",
                ClientSecret = "string",
            },
        },
        FetchTransactionsUserId = false,
        JobCheckpointInterval = 0,
        JobProductVariantsIncludePresPrices = false,
        JobTerminationThreshold = 0,
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceShopify(ctx, "sourceShopifyResource", &airbyte.SourceShopifyArgs{
Configuration: &.SourceShopifyConfigurationArgs{
Shop: pulumi.String("string"),
BulkWindowInDays: pulumi.Float64(0),
Credentials: &.SourceShopifyConfigurationCredentialsArgs{
ApiPassword: &.SourceShopifyConfigurationCredentialsApiPasswordArgs{
ApiPassword: pulumi.String("string"),
},
OAuth20: &.SourceShopifyConfigurationCredentialsOAuth20Args{
AccessToken: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
},
},
FetchTransactionsUserId: pulumi.Bool(false),
JobCheckpointInterval: pulumi.Float64(0),
JobProductVariantsIncludePresPrices: pulumi.Bool(false),
JobTerminationThreshold: pulumi.Float64(0),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceShopifyResource = new SourceShopify("sourceShopifyResource", SourceShopifyArgs.builder()
    .configuration(SourceShopifyConfigurationArgs.builder()
        .shop("string")
        .bulkWindowInDays(0)
        .credentials(SourceShopifyConfigurationCredentialsArgs.builder()
            .apiPassword(SourceShopifyConfigurationCredentialsApiPasswordArgs.builder()
                .apiPassword("string")
                .build())
            .oAuth20(SourceShopifyConfigurationCredentialsOAuth20Args.builder()
                .accessToken("string")
                .clientId("string")
                .clientSecret("string")
                .build())
            .build())
        .fetchTransactionsUserId(false)
        .jobCheckpointInterval(0)
        .jobProductVariantsIncludePresPrices(false)
        .jobTerminationThreshold(0)
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_shopify_resource = airbyte.SourceShopify("sourceShopifyResource",
    configuration={
        "shop": "string",
        "bulk_window_in_days": 0,
        "credentials": {
            "api_password": {
                "api_password": "string",
            },
            "o_auth20": {
                "access_token": "string",
                "client_id": "string",
                "client_secret": "string",
            },
        },
        "fetch_transactions_user_id": False,
        "job_checkpoint_interval": 0,
        "job_product_variants_include_pres_prices": False,
        "job_termination_threshold": 0,
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceShopifyResource = new airbyte.SourceShopify("sourceShopifyResource", {
    configuration: {
        shop: "string",
        bulkWindowInDays: 0,
        credentials: {
            apiPassword: {
                apiPassword: "string",
            },
            oAuth20: {
                accessToken: "string",
                clientId: "string",
                clientSecret: "string",
            },
        },
        fetchTransactionsUserId: false,
        jobCheckpointInterval: 0,
        jobProductVariantsIncludePresPrices: false,
        jobTerminationThreshold: 0,
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceShopify
properties:
    configuration:
        bulkWindowInDays: 0
        credentials:
            apiPassword:
                apiPassword: string
            oAuth20:
                accessToken: string
                clientId: string
                clientSecret: string
        fetchTransactionsUserId: false
        jobCheckpointInterval: 0
        jobProductVariantsIncludePresPrices: false
        jobTerminationThreshold: 0
        shop: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceShopify Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceShopify resource accepts the following input properties:

Configuration SourceShopifyConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceShopifyConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceShopifyConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceShopifyConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceShopifyConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceShopify resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
resource_allocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceShopify Resource

Get an existing SourceShopify resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceShopifyState, opts?: CustomResourceOptions): SourceShopify

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceShopifyConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceShopifyResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceShopify

func GetSourceShopify(ctx *Context, name string, id IDInput, state *SourceShopifyState, opts ...ResourceOption) (*SourceShopify, error)

public static SourceShopify Get(string name, Input<string> id, SourceShopifyState? state, CustomResourceOptions? opts = null)

public static SourceShopify get(String name, Output<String> id, SourceShopifyState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceShopify    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configuration SourceShopifyConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceShopifyConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceShopifyResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceShopifyConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceShopifyConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceShopifyResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceShopifyConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
resource_allocation SourceShopifyResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceShopifyConfiguration, SourceShopifyConfigurationArgs

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'.
BulkWindowInDays double: Defines what would be a date range per single BULK Job. Default: 30
Credentials SourceShopifyConfigurationCredentials: The authorization method to use to retrieve data from Shopify
FetchTransactionsUserId bool: 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
JobCheckpointInterval double: The threshold, after which the single BULK Job should be checkpointed (min: 15k, max: 1M). Default: 100000
JobProductVariantsIncludePresPrices bool: If enabled, the Product Variants stream attempts to include Presentment prices field (may affect the performance). Default: true
JobTerminationThreshold double: 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
StartDate 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"

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'.
BulkWindowInDays float64: Defines what would be a date range per single BULK Job. Default: 30
Credentials SourceShopifyConfigurationCredentials: The authorization method to use to retrieve data from Shopify
FetchTransactionsUserId bool: 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
JobCheckpointInterval float64: The threshold, after which the single BULK Job should be checkpointed (min: 15k, max: 1M). Default: 100000
JobProductVariantsIncludePresPrices bool: If enabled, the Product Variants stream attempts to include Presentment prices field (may affect the performance). Default: true
JobTerminationThreshold float64: 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
StartDate 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"

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'.
bulkWindowInDays Double: Defines what would be a date range per single BULK Job. Default: 30
credentials SourceShopifyConfigurationCredentials: The authorization method to use to retrieve data from Shopify
fetchTransactionsUserId 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
jobCheckpointInterval Double: The threshold, after which the single BULK Job should be checkpointed (min: 15k, max: 1M). Default: 100000
jobProductVariantsIncludePresPrices Boolean: If enabled, the Product Variants stream attempts to include Presentment prices field (may affect the performance). Default: true
jobTerminationThreshold Double: 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
startDate 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"

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'.
bulkWindowInDays number: Defines what would be a date range per single BULK Job. Default: 30
credentials SourceShopifyConfigurationCredentials: The authorization method to use to retrieve data from Shopify
fetchTransactionsUserId 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
jobCheckpointInterval number: The threshold, after which the single BULK Job should be checkpointed (min: 15k, max: 1M). Default: 100000
jobProductVariantsIncludePresPrices boolean: If enabled, the Product Variants stream attempts to include Presentment prices field (may affect the performance). Default: true
jobTerminationThreshold 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
startDate 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"

shop str: 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'.
bulk_window_in_days float: Defines what would be a date range per single BULK Job. Default: 30
credentials SourceShopifyConfigurationCredentials: The authorization method to use to retrieve data from Shopify
fetch_transactions_user_id bool: 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 float: The threshold, after which the single BULK Job should be checkpointed (min: 15k, max: 1M). Default: 100000
job_product_variants_include_pres_prices bool: If enabled, the Product Variants stream attempts to include Presentment prices field (may affect the performance). Default: true
job_termination_threshold float: 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 str: 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"

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'.
bulkWindowInDays Number: Defines what would be a date range per single BULK Job. Default: 30
credentials Property Map: The authorization method to use to retrieve data from Shopify
fetchTransactionsUserId 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
jobCheckpointInterval Number: The threshold, after which the single BULK Job should be checkpointed (min: 15k, max: 1M). Default: 100000
jobProductVariantsIncludePresPrices Boolean: If enabled, the Product Variants stream attempts to include Presentment prices field (may affect the performance). Default: true
jobTerminationThreshold 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
startDate 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"

SourceShopifyConfigurationCredentials, SourceShopifyConfigurationCredentialsArgs

ApiPassword SourceShopifyConfigurationCredentialsApiPassword: API Password Auth
OAuth20 SourceShopifyConfigurationCredentialsOAuth20: OAuth2.0

ApiPassword SourceShopifyConfigurationCredentialsApiPassword: API Password Auth
OAuth20 SourceShopifyConfigurationCredentialsOAuth20: OAuth2.0

apiPassword SourceShopifyConfigurationCredentialsApiPassword: API Password Auth
oAuth20 SourceShopifyConfigurationCredentialsOAuth20: OAuth2.0

apiPassword SourceShopifyConfigurationCredentialsApiPassword: API Password Auth
oAuth20 SourceShopifyConfigurationCredentialsOAuth20: OAuth2.0

api_password SourceShopifyConfigurationCredentialsApiPassword: API Password Auth
o_auth20 SourceShopifyConfigurationCredentialsOAuth20: OAuth2.0

apiPassword Property Map: API Password Auth
oAuth20 Property Map: OAuth2.0

SourceShopifyConfigurationCredentialsApiPassword, SourceShopifyConfigurationCredentialsApiPasswordArgs

ApiPassword string: The API Password for your private application in the Shopify store.

ApiPassword string: The API Password for your private application in the Shopify store.

apiPassword String: The API Password for your private application in the Shopify store.

apiPassword string: The API Password for your private application in the Shopify store.

api_password str: The API Password for your private application in the Shopify store.

apiPassword String: The API Password for your private application in the Shopify store.

SourceShopifyConfigurationCredentialsOAuth20, SourceShopifyConfigurationCredentialsOAuth20Args

AccessToken string: The Access Token for making authenticated requests.
ClientId string: The Client ID of the Shopify developer application.
ClientSecret string: The Client Secret of the Shopify developer application.

AccessToken string: The Access Token for making authenticated requests.
ClientId string: The Client ID of the Shopify developer application.
ClientSecret string: The Client Secret of the Shopify developer application.

accessToken String: The Access Token for making authenticated requests.
clientId String: The Client ID of the Shopify developer application.
clientSecret String: The Client Secret of the Shopify developer application.

accessToken string: The Access Token for making authenticated requests.
clientId string: The Client ID of the Shopify developer application.
clientSecret string: The Client Secret of the Shopify developer application.

access_token str: The Access Token for making authenticated requests.
client_id str: The Client ID of the Shopify developer application.
client_secret str: The Client Secret of the Shopify developer application.

accessToken String: The Access Token for making authenticated requests.
clientId String: The Client ID of the Shopify developer application.
clientSecret String: The Client Secret of the Shopify developer application.

SourceShopifyResourceAllocation, SourceShopifyResourceAllocationArgs

Default SourceShopifyResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceShopifyResourceAllocationJobSpecific>

Default SourceShopifyResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceShopifyResourceAllocationJobSpecific

default_ SourceShopifyResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceShopifyResourceAllocationJobSpecific>

default SourceShopifyResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceShopifyResourceAllocationJobSpecific[]

default SourceShopifyResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceShopifyResourceAllocationJobSpecific]

default Property Map: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceShopifyResourceAllocationDefault, SourceShopifyResourceAllocationDefaultArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

SourceShopifyResourceAllocationJobSpecific, SourceShopifyResourceAllocationJobSpecificArgs

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceShopifyResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceShopifyResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceShopifyResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceShopifyResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

job_type str: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceShopifyResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map: optional resource requirements to run workers (blank for unbounded allocations)

SourceShopifyResourceAllocationJobSpecificResourceRequirements, SourceShopifyResourceAllocationJobSpecificResourceRequirementsArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

Import

$ pulumi import airbyte:index/sourceShopify:SourceShopify my_airbyte_source_shopify ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceShopify

On this page

On this page

Example Usage

Create SourceShopify Resource

Constructor syntax

Parameters

Constructor example

SourceShopify Resource Properties

Inputs

Outputs

Look up Existing SourceShopify Resource

Supporting Types

SourceShopifyConfiguration, SourceShopifyConfigurationArgs

SourceShopifyConfigurationCredentials, SourceShopifyConfigurationCredentialsArgs

SourceShopifyConfigurationCredentialsApiPassword, SourceShopifyConfigurationCredentialsApiPasswordArgs

SourceShopifyConfigurationCredentialsOAuth20, SourceShopifyConfigurationCredentialsOAuth20Args

SourceShopifyResourceAllocation, SourceShopifyResourceAllocationArgs

SourceShopifyResourceAllocationDefault, SourceShopifyResourceAllocationDefaultArgs

SourceShopifyResourceAllocationJobSpecific, SourceShopifyResourceAllocationJobSpecificArgs

SourceShopifyResourceAllocationJobSpecificResourceRequirements, SourceShopifyResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page