Shopify List

Shopify List

Certified

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.

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

List all products

yaml
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

yaml
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

yaml
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

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

Created at max

Return products created at or before this ISO-8601 timestamp

Created at min

Return products created at or after this ISO-8601 timestamp

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

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

Handle filter

Filter products by product handle

Limit

Maximum number of products to retrieve (1-250)

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

Product type filter

Filter products by product type string

Possible Values
PUBLISHEDUNPUBLISHEDANY

Published status filter

Published state filter: published, unpublished, or any

DefaultPT0.5S

Rate limit delay

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

Since ID

Retrieve products created after this Shopify product ID

Possible Values
ACTIVEARCHIVEDDRAFT

Product status filter

Product status filter: active, archived, or draft

Updated at max

Return products updated at or before this ISO-8601 timestamp

Updated at min

Return products updated at or after this ISO-8601 timestamp

Vendor filter

Filter products by vendor

Count

Number of products returned or written

Products

Products retrieved when fetchType is FETCH or FETCH_ONE

Definitions
admin_graphql_api_idstring
body_htmlstring
created_atstring
Formatdate-time
handlestring
idinteger
imagesarray
admin_graphql_api_idstring
altstring
created_atstring
Formatdate-time
heightinteger
idinteger
positioninteger
product_idinteger
srcstring
updated_atstring
Formatdate-time
variant_idsarray
SubTypeinteger
widthinteger
metafieldsobject
optionsarray
idinteger
namestring
positioninteger
product_idinteger
valuesarray
SubTypestring
product_typestring
published_atstring
Formatdate-time
published_scopestring
statusstring
tagsstring
template_suffixstring
titlestring
updated_atstring
Formatdate-time
variantsarray
admin_graphql_api_idstring
barcodestring
compare_at_pricestring
created_atstring
Formatdate-time
fulfillment_servicestring
gramsnumber
idinteger
image_idinteger
inventory_item_idinteger
inventory_managementstring
inventory_policystring
inventory_quantityinteger
old_inventory_quantityinteger
option1string
option2string
option3string
positionstring
pricestring
product_idinteger
requires_shippingboolean
skustring
taxableboolean
titlestring
updated_atstring
Formatdate-time
weightnumber
weight_unitstring
vendorstring
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