Shopify List
CertifiedList Shopify orders
Shopify List
Certified
List Shopify orders
Retrieves orders through the Shopify Admin API with optional filters (status, financial, fulfillment, date ranges). Supports fetch modes: FETCH (default), FETCH_ONE (first only), STORE (stream to storage URI). Limit honors Shopify cap.
yaml
type: io.kestra.plugin.shopify.orders.ListExamples
List all orders
yaml
id: shopify_list_orders
namespace: company.team
tasks:
- id: list_orders
type: io.kestra.plugin.shopify.orders.List
storeDomain: my-store.myshopify.com
accessToken: "{{ secret('SHOPIFY_ACCESS_TOKEN') }}"
List orders with filtering
yaml
id: shopify_list_orders_filtered
namespace: company.team
tasks:
- id: list_orders
type: io.kestra.plugin.shopify.orders.List
storeDomain: my-store.myshopify.com
accessToken: "{{ secret('SHOPIFY_ACCESS_TOKEN') }}"
limit: 50
status: "any"
financialStatus: "paid"
Stream orders to storage
yaml
id: shopify_list_orders_store
namespace: company.team
tasks:
- id: list_orders
type: io.kestra.plugin.shopify.orders.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
Default
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.
Definitions
io.kestra.core.models.assets.AssetsDeclaration
assetFailureBehaviorstring
Possible Values
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.
enableAutobooleanstring
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
inputsarray
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
id*string
Min length
1typestring
outputs
The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
id*string
Min length
1Max length
150type*object
descriptionstring
displayNamestring
metadataobject
Default
{}namespacestring
Min length
1Max length
150io.kestra.plugin.ee.assets.File
id*string
Min length
1Max length
150type*object
descriptionstring
displayNamestring
metadataobject
Default
{}namespacestring
Min length
1Max length
150io.kestra.plugin.ee.assets.Table
id*string
Min length
1Max length
150type*object
descriptionstring
displayNamestring
metadataobject
Default
{}namespacestring
Min length
1Max length
150io.kestra.plugin.ee.assets.VM
id*string
Min length
1Max length
150type*object
descriptionstring
displayNamestring
metadataobject
Default
{}namespacestring
Min length
1Max length
150io.kestra.core.models.assets.External
id*string
Min length
1Max length
150type*object
descriptionstring
displayNamestring
metadataobject
Default
{}namespacestring
Min length
1Max length
150io.kestra.core.models.assets.Custom
id*string
Min length
1Max length
150type*string
Min length
1Custom asset type
descriptionstring
displayNamestring
metadataobject
Default
{}namespacestring
Min length
1Max length
150createdAtMax string
Created at max
Return orders created at or before this ISO-8601 timestamp
createdAtMin string
Created at min
Return orders created at or after this ISO-8601 timestamp
fetchType string
Default
FETCHPossible Values
STOREFETCHFETCH_ONENONEFetch type
Controls result handling: FETCH (default), FETCH_ONE, or STORE
financialStatus string
Financial status filter
Financial status filter (e.g., paid, pending, refunded)
fulfillmentStatus string
Fulfillment status filter
Fulfillment status filter (e.g., shipped, partial, unshipped)
limit integerstring
Limit
Maximum number of orders to retrieve (1-250)
rateLimitDelay string
Default
PT0.5SRate limit delay
Sleep between API calls to respect Shopify rate limits; default 500ms
sinceId integerstring
Since ID
Retrieve orders created after this Shopify order ID
status string
Status filter
Order status filter: open, closed, cancelled, or any
updatedAtMax string
Updated at max
Return orders updated at or before this ISO-8601 timestamp
updatedAtMin string
Updated at min
Return orders updated at or after this ISO-8601 timestamp
Outputs
count integer
Count
Number of orders returned or written
orders array
Orders
Orders retrieved when fetchType is FETCH or FETCH_ONE
Definitions
io.kestra.plugin.shopify.models.Order
admin_graphql_api_idstring
app_idinteger
billing_address
io.kestra.plugin.shopify.models.Order-Address
address1string
address2string
citystring
companystring
countrystring
country_codestring
first_namestring
last_namestring
latitudenumber
longitudenumber
namestring
phonestring
provincestring
province_codestring
zipstring
browser_ipstring
buyer_accepts_marketingboolean
cancel_reasonstring
cancelled_atstring
Format
date-timecart_tokenstring
checkout_idinteger
checkout_tokenstring
closed_atstring
Format
date-timeconfirmedboolean
contact_emailstring
created_atstring
Format
date-timecurrencystring
current_subtotal_pricestring
current_subtotal_price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
current_total_discountsstring
current_total_discounts_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
current_total_duties_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
current_total_pricestring
current_total_price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
current_total_taxstring
current_total_tax_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
customer
io.kestra.plugin.shopify.models.Customer
accepts_marketingboolean
accepts_marketing_updated_atstring
Format
date-timeaddressesarray
io.kestra.plugin.shopify.models.Customer-CustomerAddress
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
Format
date-timecurrencystring
default_address
io.kestra.plugin.shopify.models.Customer-CustomerAddress
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
Format
date-timeverified_emailboolean
customer_localestring
device_idstring
discount_applicationsarray
io.kestra.plugin.shopify.models.Order-DiscountApplication
allocation_methodstring
descriptionstring
target_selectionstring
target_typestring
titlestring
typestring
valuestring
value_typestring
discount_codesarray
io.kestra.plugin.shopify.models.Order-DiscountCode
amountstring
codestring
typestring
emailstring
estimated_taxesboolean
financial_statusstring
fulfillment_statusstring
fulfillmentsarray
io.kestra.plugin.shopify.models.Order-Fulfillment
created_atstring
Format
date-timeidinteger
line_itemsarray
io.kestra.plugin.shopify.models.Order-LineItem
admin_graphql_api_idstring
discount_allocationsarray
dutiesarray
SubTypeobject
fulfillable_quantityinteger
fulfillment_servicestring
fulfillment_statusstring
gift_cardboolean
gramsinteger
idinteger
namestring
pricestring
price_set
product_existsboolean
product_idinteger
propertiesobject
quantityinteger
requires_shippingboolean
skustring
tax_linesarray
taxableboolean
titlestring
total_discountstring
total_discount_set
variant_idinteger
variant_inventory_managementstring
variant_titlestring
vendorstring
order_idinteger
receipt
io.kestra.plugin.shopify.models.Order-Receipt
authorizationstring
testcaseboolean
servicestring
statusstring
tracking_companystring
tracking_numberstring
tracking_numbersarray
SubTypestring
tracking_urlstring
tracking_urlsarray
SubTypestring
updated_atstring
Format
date-timegatewaystring
idinteger
landing_sitestring
landing_site_refstring
line_itemsarray
io.kestra.plugin.shopify.models.Order-LineItem
admin_graphql_api_idstring
discount_allocationsarray
io.kestra.plugin.shopify.models.Order-DiscountAllocation
amountstring
amount_set
discount_application_indexinteger
dutiesarray
SubTypeobject
fulfillable_quantityinteger
fulfillment_servicestring
fulfillment_statusstring
gift_cardboolean
gramsinteger
idinteger
namestring
pricestring
price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
shop_money
product_existsboolean
product_idinteger
propertiesobject
quantityinteger
requires_shippingboolean
skustring
tax_linesarray
io.kestra.plugin.shopify.models.Order-TaxLine
channel_liableboolean
pricestring
price_set
ratenumber
titlestring
taxableboolean
titlestring
total_discountstring
total_discount_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
shop_money
variant_idinteger
variant_inventory_managementstring
variant_titlestring
vendorstring
location_idinteger
namestring
notestring
note_attributesarray
io.kestra.plugin.shopify.models.Order-NoteAttribute
namestring
valuestring
numberinteger
order_numberinteger
order_status_urlstring
original_total_duties_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
payment_gateway_namesarray
SubTypestring
payment_terms
io.kestra.plugin.shopify.models.Order-PaymentTerms
amountinteger
currencystring
due_in_daysinteger
payment_schedulesarray
io.kestra.plugin.shopify.models.Order-PaymentSchedule
amountinteger
completed_atstring
Format
date-timecurrencystring
due_atstring
Format
date-timeexpected_payment_methodstring
issued_atstring
Format
date-timepayment_terms_namestring
payment_terms_typestring
phonestring
presentment_currencystring
processed_atstring
Format
date-timeprocessing_methodstring
referencestring
referring_sitestring
refundsarray
io.kestra.plugin.shopify.models.Order-Refund
admin_graphql_api_idstring
created_atstring
Format
date-timedutiesarray
SubTypeobject
idinteger
notestring
order_adjustmentsarray
io.kestra.plugin.shopify.models.Order-OrderAdjustment
amountstring
amount_set
idinteger
kindstring
order_idinteger
reasonstring
refund_idinteger
tax_amountstring
tax_amount_set
order_idinteger
processed_atstring
Format
date-timerefund_line_itemsarray
io.kestra.plugin.shopify.models.Order-RefundLineItem
idinteger
line_item
line_item_idinteger
location_idinteger
quantityinteger
restock_typestring
subtotalstring
subtotal_set
total_taxstring
total_tax_set
restockboolean
total_duties_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
shop_money
transactionsarray
io.kestra.plugin.shopify.models.Order-Transaction
admin_graphql_api_idstring
amountstring
authorizationstring
created_atstring
Format
date-timecurrencystring
currency_exchange_adjustment
device_idstring
error_codestring
gatewaystring
idinteger
kindstring
location_idinteger
messagestring
order_idinteger
parent_idinteger
processed_atstring
Format
date-timereceipt
source_namestring
statusstring
testboolean
user_idinteger
user_idinteger
shipping_address
io.kestra.plugin.shopify.models.Order-Address
address1string
address2string
citystring
companystring
countrystring
country_codestring
first_namestring
last_namestring
latitudenumber
longitudenumber
namestring
phonestring
provincestring
province_codestring
zipstring
shipping_linesarray
io.kestra.plugin.shopify.models.Order-ShippingLine
carrier_identifierstring
codestring
delivery_categorystring
discount_allocationsarray
io.kestra.plugin.shopify.models.Order-DiscountAllocation
amountstring
amount_set
discount_application_indexinteger
discounted_pricestring
discounted_price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
shop_money
idinteger
phonestring
pricestring
price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
shop_money
requested_fulfillment_service_idstring
sourcestring
tax_linesarray
io.kestra.plugin.shopify.models.Order-TaxLine
channel_liableboolean
pricestring
price_set
ratenumber
titlestring
titlestring
source_identifierstring
source_namestring
source_urlstring
subtotal_pricestring
subtotal_price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
tagsstring
tax_linesarray
io.kestra.plugin.shopify.models.Order-TaxLine
channel_liableboolean
pricestring
price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
shop_money
ratenumber
titlestring
taxes_includedboolean
testboolean
tokenstring
total_discountsstring
total_discounts_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
total_line_items_pricestring
total_line_items_price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
total_outstandingstring
total_pricestring
total_price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
total_price_usdstring
total_shipping_price_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
total_taxstring
total_tax_set
io.kestra.plugin.shopify.models.Order-PriceSet
presentment_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
shop_money
io.kestra.plugin.shopify.models.Order-Money
amountstring
currency_codestring
total_tip_receivedstring
total_weightinteger
updated_atstring
Format
date-timeuser_idinteger
uri string
Format
uriURI
Storage URI written when fetchType is STORE
