Shopify List

Shopify List

Certified

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).

yaml
type: io.kestra.plugin.shopify.customers.List

List all customers

yaml
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

yaml
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

Admin API access token

Private app Admin API access token sent as X-Shopify-Access-Token

Shopify store domain

Store domain used for Admin API calls (e.g., my-store.myshopify.com)

Default2024-10

API version

Shopify Admin API version path segment; defaults to 2024-10

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

Controls result handling: FETCH (default), FETCH_ONE, or STORE

Customer limit

Maximum customers to return (1-250). Shopify caps at 250.

Reference (ref) of the pluginDefaults to apply to this task.

DefaultPT0.5S

Rate limit delay

Sleep between API calls to respect Shopify rate limits; default 500ms

Count

Number of customers returned or written

Customers

Customers retrieved when fetchType is FETCH or FETCH_ONE

Definitions
accepts_marketingboolean
accepts_marketing_updated_atstring
Formatdate-time
addressesarray
address1string
address2string
citystring
companystring
countrystring
country_codestring
country_namestring
customer_idinteger
defaultboolean
first_namestring
idinteger
last_namestring
namestring
phonestring
provincestring
province_codestring
zipstring
admin_graphql_api_idstring
created_atstring
Formatdate-time
currencystring
default_address
address1string
address2string
citystring
companystring
countrystring
country_codestring
country_namestring
customer_idinteger
defaultboolean
first_namestring
idinteger
last_namestring
namestring
phonestring
provincestring
province_codestring
zipstring
emailstring
first_namestring
idinteger
last_namestring
last_order_idinteger
last_order_namestring
marketing_opt_in_levelstring
metafieldsobject
multipass_identifierstring
notestring
orders_countinteger
phonestring
statestring
tagsstring
tax_exemptboolean
tax_exemptionsarray
SubTypestring
total_spentstring
updated_atstring
Formatdate-time
verified_emailboolean
Formaturi

URI

Storage URI written when fetchType is STORE

More Plugins in this Category

Stripe
Stripe

Tasks that interact with Stripe customers, payments, balances, and webhooks.

Business

15 tasks

1 blueprints

Klaviyo
Klaviyo

Tasks that interact with Klaviyo campaign APIs.

AIBusiness

7 tasks

3 blueprints