List

List orders from Shopify store

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

yaml
type: "io.kestra.plugin.shopify.orders.List"

Examples

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"

Properties

accessToken *string

Admin API access token

Private app access token for Shopify Admin API

storeDomain *string

Shopify store domain

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

apiVersion string

Default 2024-10

API version

Shopify Admin API version to use

createdAtMax string

Created at max

Retrieve orders created before this date

createdAtMin string

Created at min

Retrieve orders created after this date

fetchType string

Default FETCH

Possible Values

STOREFETCHFETCH_ONENONE

Fetch type

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

financialStatus string

Financial status filter

Filter orders by financial status

fulfillmentStatus string

Fulfillment status filter

Filter orders by fulfillment status

limit integerstring

Limit

Maximum number of orders to retrieve

rateLimitDelay string

Default PT0.5S

Format duration

Rate limit delay

Delay between API calls to respect rate limits

sinceId integerstring

Since ID

Retrieve orders after this ID

status string

Status filter

Filter orders by status (open, closed, cancelled, any)

updatedAtMax string

Updated at max

Retrieve orders updated before this date

updatedAtMin string

Updated at min

Retrieve orders updated after this date

Outputs

count integer

Count

Number of orders retrieved

orders array

SubType

Orders

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

uri string

Format uri

URI

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

Definitions

io.kestra.plugin.shopify.models.Order-PaymentSchedule

amount integer

completed_at string

Format date-time

currency string

due_at string

Format date-time

expected_payment_method string

issued_at string

Format date-time

io.kestra.plugin.shopify.models.Customer

accepts_marketing boolean

accepts_marketing_updated_at string

Format date-time

addresses array

SubType

admin_graphql_api_id string

created_at string

Format date-time

currency string

default_address Customer-CustomerAddress

email string

first_name string

id integer

last_name string

last_order_id integer

last_order_name string

marketing_opt_in_level string

metafields object

multipass_identifier string

note string

orders_count integer

phone string

state string

tags string

tax_exempt boolean

tax_exemptions array

SubType string

total_spent string

updated_at string

Format date-time

verified_email boolean

io.kestra.plugin.shopify.models.Order-PaymentTerms

amount integer

currency string

due_in_days integer

payment_schedules array

SubType

payment_terms_name string

payment_terms_type string

io.kestra.plugin.shopify.models.Order-ShippingLine

carrier_identifier string

code string

delivery_category string

discount_allocations array

SubType

discounted_price string

discounted_price_set Order-PriceSet

id integer

phone string

price string

price_set Order-PriceSet

requested_fulfillment_service_id string

source string

tax_lines array

SubType

title string

io.kestra.plugin.shopify.models.Order-PriceSet

presentment_money Order-Money

shop_money Order-Money

io.kestra.plugin.shopify.models.Order-Address

address1 string

address2 string

city string

company string

country string

country_code string

first_name string

last_name string

latitude number

longitude number

name string

phone string

province string

province_code string

zip string

io.kestra.plugin.shopify.models.Order-DiscountAllocation

amount string

amount_set Order-PriceSet

discount_application_index integer

io.kestra.plugin.shopify.models.Order-CurrencyExchangeAdjustment

adjustment string

currency string

final_amount string

original_amount string

io.kestra.plugin.shopify.models.Order-Money

amount string

currency_code string

io.kestra.plugin.shopify.models.Order-RefundLineItem

id integer

line_item Order-LineItem

line_item_id integer

location_id integer

quantity integer

restock_type string

subtotal string

subtotal_set Order-PriceSet

total_tax string

total_tax_set Order-PriceSet

io.kestra.plugin.shopify.models.Order-TaxLine

channel_liable boolean

price string

price_set Order-PriceSet

rate number

title string

io.kestra.plugin.shopify.models.Order-Transaction

admin_graphql_api_id string

amount string

authorization string

created_at string

Format date-time

currency string

currency_exchange_adjustment Order-CurrencyExchangeAdjustment

device_id string

error_code string

gateway string

id integer

kind string

location_id integer

message string

order_id integer

parent_id integer

processed_at string

Format date-time

receipt Order-Receipt

source_name string

status string

test boolean

user_id integer

io.kestra.plugin.shopify.models.Customer-CustomerAddress

address1 string

address2 string

city string

company string

country string

country_code string

country_name string

customer_id integer

default boolean

first_name string

id integer

last_name string

name string

phone string

province string

province_code string

zip string

io.kestra.plugin.shopify.models.Order-OrderAdjustment

amount string

amount_set Order-PriceSet

id integer

kind string

order_id integer

reason string

refund_id integer

tax_amount string

tax_amount_set Order-PriceSet

io.kestra.plugin.shopify.models.Order-LineItem

admin_graphql_api_id string

discount_allocations array

SubType

duties array

SubType object

fulfillable_quantity integer

fulfillment_service string

fulfillment_status string

gift_card boolean

grams integer

id integer

name string

price string

price_set Order-PriceSet

product_exists boolean

product_id integer

properties object

quantity integer

requires_shipping boolean

sku string

tax_lines array

SubType

taxable boolean

title string

total_discount string

total_discount_set Order-PriceSet

variant_id integer

variant_inventory_management string

variant_title string

vendor string

io.kestra.plugin.shopify.models.Order-Fulfillment

created_at string

Format date-time

id integer

line_items array

SubType

order_id integer

receipt Order-Receipt

service string

status string

tracking_company string

tracking_number string

tracking_numbers array

SubType string

tracking_url string

tracking_urls array

SubType string

updated_at string

Format date-time

io.kestra.plugin.shopify.models.Order-NoteAttribute

name string

value string

io.kestra.plugin.shopify.models.Order-DiscountApplication

allocation_method string

description string

target_selection string

target_type string

title string

type string

value string

value_type string

io.kestra.plugin.shopify.models.Order-DiscountCode

amount string

code string

type string

io.kestra.plugin.shopify.models.Order

admin_graphql_api_id string

app_id integer

billing_address Order-Address

browser_ip string

buyer_accepts_marketing boolean

cancel_reason string

cancelled_at string

Format date-time

cart_token string

checkout_id integer

checkout_token string

closed_at string

Format date-time

confirmed boolean

contact_email string

created_at string

Format date-time

currency string

current_subtotal_price string

current_subtotal_price_set Order-PriceSet

current_total_discounts string

current_total_discounts_set Order-PriceSet

current_total_duties_set Order-PriceSet

current_total_price string

current_total_price_set Order-PriceSet

current_total_tax string

current_total_tax_set Order-PriceSet

customer Customer

customer_locale string

device_id string

discount_applications array

SubType

discount_codes array

SubType

email string

estimated_taxes boolean

financial_status string

fulfillment_status string

fulfillments array

SubType

gateway string

id integer

landing_site string

landing_site_ref string

line_items array

SubType

location_id integer

name string

note string

note_attributes array

SubType

number integer

order_number integer

order_status_url string

original_total_duties_set Order-PriceSet

payment_gateway_names array

SubType string

payment_terms Order-PaymentTerms

phone string

presentment_currency string

processed_at string

Format date-time

processing_method string

reference string

referring_site string

refunds array

SubType

shipping_address Order-Address

shipping_lines array

SubType

source_identifier string

source_name string

source_url string

subtotal_price string

subtotal_price_set Order-PriceSet

tags string

tax_lines array

SubType

taxes_included boolean

test boolean

token string

total_discounts string

total_discounts_set Order-PriceSet

total_line_items_price string

total_line_items_price_set Order-PriceSet

total_outstanding string

total_price string

total_price_set Order-PriceSet

total_price_usd string

total_shipping_price_set Order-PriceSet

total_tax string

total_tax_set Order-PriceSet

total_tip_received string

total_weight integer

updated_at string

Format date-time

user_id integer

io.kestra.plugin.shopify.models.Order-Refund

admin_graphql_api_id string

created_at string

Format date-time

duties array

SubType object

id integer

note string

order_adjustments array

SubType

order_id integer

processed_at string

Format date-time

refund_line_items array

SubType

restock boolean

total_duties_set Order-PriceSet

transactions array

SubType

user_id integer

io.kestra.plugin.shopify.models.Order-Receipt

authorization string

testcase boolean

​List

List