
Shopify List
CertifiedList Shopify products
Shopify List
List Shopify products
Retrieves products via the Shopify Admin API with optional filters (status, published state, vendor, type, date ranges). Supports fetch modes: FETCH (default), FETCH_ONE (first only), or STORE (stream to storage URI). Limit honors Shopify cap.
type: io.kestra.plugin.shopify.products.ListExamples
List all products
id: shopify_list_products
namespace: company.team
tasks:
- id: list_products
type: io.kestra.plugin.shopify.products.List
storeDomain: my-store.myshopify.com
accessToken: "{{ secret('SHOPIFY_ACCESS_TOKEN') }}"
List products with filtering
id: shopify_list_products_filtered
namespace: company.team
tasks:
- id: list_products
type: io.kestra.plugin.shopify.products.List
storeDomain: my-store.myshopify.com
accessToken: "{{ secret('SHOPIFY_ACCESS_TOKEN') }}"
limit: 50
status: ACTIVE
publishedStatus: PUBLISHED
Stream products to storage
id: shopify_list_products_store
namespace: company.team
tasks:
- id: list_products
type: io.kestra.plugin.shopify.products.List
storeDomain: my-store.myshopify.com
accessToken: "{{ secret('SHOPIFY_ACCESS_TOKEN') }}"
fetchType: STORE
limit: 200
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
{}1150createdAtMax string
Created at max
Return products created at or before this ISO-8601 timestamp
createdAtMin string
Created at min
Return products created at or after this ISO-8601 timestamp
fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch type
Controls result handling: FETCH (default), FETCH_ONE, or STORE
handle string
Handle filter
Filter products by product handle
limit integerstring
Limit
Maximum number of products to retrieve (1-250)
productType string
Product type filter
Filter products by product type string
publishedStatus string
PUBLISHEDUNPUBLISHEDANYPublished status filter
Published state filter: published, unpublished, or any
rateLimitDelay string
PT0.5SRate limit delay
Sleep between API calls to respect Shopify rate limits; default 500ms
sinceId integerstring
Since ID
Retrieve products created after this Shopify product ID
status string
ACTIVEARCHIVEDDRAFTProduct status filter
Product status filter: active, archived, or draft
updatedAtMax string
Updated at max
Return products updated at or before this ISO-8601 timestamp
updatedAtMin string
Updated at min
Return products updated at or after this ISO-8601 timestamp
vendor string
Vendor filter
Filter products by vendor
Outputs
count integer
Count
Number of products returned or written
products array
Products
Products retrieved when fetchType is FETCH or FETCH_ONE
io.kestra.plugin.shopify.models.Product
date-timeio.kestra.plugin.shopify.models.Product-ProductImage
date-timedate-timeio.kestra.plugin.shopify.models.Product-ProductOption
date-timedate-timeio.kestra.plugin.shopify.models.Product-ProductVariant
date-timedate-timeuri string
uriURI
Storage URI written when fetchType is STORE