pluginsplugin-shopify

List products from Shopify store

Retrieve a list of products from your Shopify store with optional filtering and pagination.

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
Properties

Admin API access token

Private app access token for Shopify Admin API

Shopify store domain

The domain of your Shopify store (e.g., 'my-store.myshopify.com')

Default 2024-10

API version

Shopify Admin API version to use

Created at max

Retrieve products created before this date

Created at min

Retrieve products created after this date

Default FETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

How to fetch the data (FETCH_ONE, FETCH, STORE)

Handle filter

Filter products by handle

Limit

Maximum number of products to retrieve

Product type filter

Filter products by product type

Possible Values
PUBLISHEDUNPUBLISHEDANY

Published status filter

Filter by published status

Default PT0.5S
Format duration

Rate limit delay

Delay between API calls to respect rate limits

Since ID

Retrieve products after this ID

Possible Values
ACTIVEARCHIVEDDRAFT

Product status filter

Filter products by status

Updated at max

Retrieve products updated before this date

Updated at min

Retrieve products updated after this date

Vendor filter

Filter products by vendor

Count

Number of products retrieved

SubType

Products

List of products retrieved from Shopify. Only populated if using fetchType=FETCH or FETCH_ONE.

Format uri

URI

URI of the stored data. Only populated if using fetchType=STORE.

SubType string
Format date-time
Format date-time
Format date-time
Format date-time
SubType integer
Format date-time
Format date-time
Format date-time