
Shopify List
CertifiedList Shopify customers
Shopify List
List Shopify customers
Retrieves customers from the Shopify Admin API. Supports limit up to 250 and fetch modes: FETCH (all), FETCH_ONE (first only), or STORE (stream to storage URI).
type: io.kestra.plugin.shopify.customers.ListExamples
List all customers
id: shopify_list_customers
namespace: company.team
tasks:
- id: list_customers
type: io.kestra.plugin.shopify.customers.List
storeDomain: my-store.myshopify.com
accessToken: "{{ secret('SHOPIFY_ACCESS_TOKEN') }}"
Store customers to internal storage
id: shopify_list_customers_store
namespace: company.team
tasks:
- id: list_customers
type: io.kestra.plugin.shopify.customers.List
storeDomain: my-store.myshopify.com
accessToken: "{{ secret('SHOPIFY_ACCESS_TOKEN') }}"
fetchType: STORE
limit: 250
Properties
accessToken *string
Admin API access token
Private app Admin API access token sent as X-Shopify-Access-Token
storeDomain *string
Shopify store domain
Store domain used for Admin API calls (e.g., my-store.myshopify.com)
apiVersion string
2024-10API version
Shopify Admin API version path segment; defaults to 2024-10
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch type
Controls result handling: FETCH (default), FETCH_ONE, or STORE
limit integerstring
Customer limit
Maximum customers to return (1-250). Shopify caps at 250.
rateLimitDelay string
PT0.5SRate limit delay
Sleep between API calls to respect Shopify rate limits; default 500ms
Outputs
count integer
Count
Number of customers returned or written
customers array
Customers
Customers retrieved when fetchType is FETCH or FETCH_ONE
io.kestra.plugin.shopify.models.Customer
date-timeio.kestra.plugin.shopify.models.Customer-CustomerAddress
date-timeio.kestra.plugin.shopify.models.Customer-CustomerAddress
date-timeuri string
uriURI
Storage URI written when fetchType is STORE