orders

Returns a list of orders placed in the store, including data such as order status, customer, and line item details.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the orders action (under Orders).
Fill in the fields below, then reference the result from later steps as {{orders.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Orders($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: OrderSortKeys, $query: String, $savedSearchId: ID) {
  orders(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
    savedSearchId: $savedSearchId
  ) {
    edges {
      cursor
      node {
        additionalFees
        alerts
        app
        attribution
        billingAddress
        billingAddressMatchesShippingAddress
        canMarkAsPaid
        canNotifyCustomer
        cancelReason
        cancellation
        cancelledAt
        capturable
        cartDiscountAmount
        cartDiscountAmountSet
        cartToken
        channel
        channelInformation
        checkoutToken
        clientIp
        closed
        closedAt
        confirmationNumber
        confirmed
        createdAt
        currencyCode
        currentCartDiscountAmountSet
        currentShippingPriceSet
        currentSubtotalLineItemsQuantity
        currentSubtotalPriceSet
        currentTaxLines
        currentTotalAdditionalFeesSet
        currentTotalDiscountsSet
        currentTotalDutiesSet
        currentTotalPriceSet
        currentTotalTaxSet
        currentTotalWeight
        customAttributes
        customer
        customerAcceptsMarketing
        customerJourney
        customerJourneySummary
        customerLocale
        discountCode
        discountCodes
        displayAddress
        displayFinancialStatus
        displayFulfillmentStatus
        disputes
        dutiesIncluded
        edited
        email
        estimatedTaxes
        fulfillable
        fulfillmentsCount
        fullyPaid
        hasTimelineComment
        id
        landingPageDisplayText
        landingPageUrl
        legacyResourceId
        merchantBusinessEntity
        merchantEditable
        merchantEditableErrors
        merchantOfRecordApp
        name
        netPayment
        netPaymentSet
        note
        number
        originalTotalAdditionalFeesSet
        originalTotalDutiesSet
        originalTotalPriceSet
        paymentCollectionDetails
        paymentGatewayNames
        paymentTerms
        phone
        physicalLocation
        poNumber
        presentmentCurrencyCode
        processedAt
        productNetwork
        publication
        purchasingEntity
        referralCode
        referrerDisplayText
        referrerUrl
        refundDiscrepancySet
        refundable
        registeredSourceUrl
        requiresShipping
        restockable
        retailLocation
        returnStatus
        risk
        riskLevel
        shippingAddress
        shippingLine
        shopifyProtect
        sourceIdentifier
        sourceName
        staffMember
        subtotalLineItemsQuantity
        subtotalPrice
        subtotalPriceSet
        tags
        taxExempt
        taxLines
        taxesIncluded
        test
        totalCapturable
        totalCapturableSet
        totalCashRoundingAdjustment
        totalDiscounts
        totalDiscountsSet
        totalOutstandingSet
        totalPrice
        totalPriceSet
        totalReceived
        totalReceivedSet
        totalRefunded
        totalRefundedSet
        totalRefundedShippingSet
        totalShippingPrice
        totalShippingPriceSet
        totalTax
        totalTaxSet
        totalTipReceived
        totalTipReceivedSet
        totalWeight
        transactionsCount
        unpaid
        updatedAt
      }
    }
    nodes {
      additionalFees {
        id
        name
        price
        taxLines
      }
      alerts {
        actions
        content
        dismissibleHandle
        icon
        severity
        title
      }
      app {
        icon
        id
        name
      }
      attribution {
        displayName
        handle
        icon
      }
      billingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      billingAddressMatchesShippingAddress
      canMarkAsPaid
      canNotifyCustomer
      cancelReason
      cancellation {
        staffNote
      }
      cancelledAt
      capturable
      cartDiscountAmount
      cartDiscountAmountSet {
        presentmentMoney
        shopMoney
      }
      cartToken
      channel {
        accountId
        accountName
        activeRegions
        app
        handle
        id
        marketsCount
        name
        navigationItems
        overviewPath
        resourceFeedback
        specificationHandle
        supportsFuturePublishing
      }
      channelInformation {
        app
        channelDefinition
        channelId
        displayName
        id
      }
      checkoutToken
      clientIp
      closed
      closedAt
      confirmationNumber
      confirmed
      createdAt
      currencyCode
      currentCartDiscountAmountSet {
        presentmentMoney
        shopMoney
      }
      currentShippingPriceSet {
        presentmentMoney
        shopMoney
      }
      currentSubtotalLineItemsQuantity
      currentSubtotalPriceSet {
        presentmentMoney
        shopMoney
      }
      currentTaxLines {
        channelLiable
        price
        priceSet
        rate
        ratePercentage
        source
        title
      }
      currentTotalAdditionalFeesSet {
        presentmentMoney
        shopMoney
      }
      currentTotalDiscountsSet {
        presentmentMoney
        shopMoney
      }
      currentTotalDutiesSet {
        presentmentMoney
        shopMoney
      }
      currentTotalPriceSet {
        presentmentMoney
        shopMoney
      }
      currentTotalTaxSet {
        presentmentMoney
        shopMoney
      }
      currentTotalWeight
      customAttributes {
        key
        value
      }
      customer {
        amountSpent
        canDelete
        companyContactProfiles
        createdAt
        dataSaleOptOut
        defaultAddress
        defaultEmailAddress
        defaultPhoneNumber
        displayName
        email
        emailMarketingConsent
        firstName
        hasTimelineComment
        id
        identityProviderSubjects
        lastName
        lastOrder
        legacyResourceId
        lifetimeDuration
        locale
        market
        mergeable
        multipassIdentifier
        note
        numberOfOrders
        phone
        productSubscriberStatus
        smsMarketingConsent
        state
        statistics
        tags
        taxExempt
        taxExemptions
        taxSettings
        unsubscribeUrl
        updatedAt
        validEmailAddress
        verifiedEmail
      }
      customerAcceptsMarketing
      customerJourney {
        customerOrderIndex
        daysToConversion
        firstVisit
        lastVisit
        moments
      }
      customerJourneySummary {
        customerOrderIndex
        daysToConversion
        firstVisit
        lastVisit
        momentsCount
        ready
      }
      customerLocale
      discountCode
      discountCodes
      displayAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      displayFinancialStatus
      displayFulfillmentStatus
      disputes {
        id
        initiatedAs
        status
      }
      dutiesIncluded
      edited
      email
      estimatedTaxes
      fulfillable
      fulfillmentsCount {
        count
        precision
      }
      fullyPaid
      hasTimelineComment
      id
      landingPageDisplayText
      landingPageUrl
      legacyResourceId
      merchantBusinessEntity {
        address
        archived
        companyName
        displayName
        id
        legalEntityId
        primary
        shopifyPaymentsAccount
      }
      merchantEditable
      merchantEditableErrors
      merchantOfRecordApp {
        icon
        id
        name
      }
      name
      netPayment
      netPaymentSet {
        presentmentMoney
        shopMoney
      }
      note
      number
      originalTotalAdditionalFeesSet {
        presentmentMoney
        shopMoney
      }
      originalTotalDutiesSet {
        presentmentMoney
        shopMoney
      }
      originalTotalPriceSet {
        presentmentMoney
        shopMoney
      }
      paymentCollectionDetails {
        additionalPaymentCollectionUrl
        vaultedPaymentMethods
      }
      paymentGatewayNames
      paymentTerms {
        draftOrder
        due
        dueInDays
        id
        order
        overdue
        paymentTermsName
        paymentTermsType
        translatedName
      }
      phone
      physicalLocation {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      poNumber
      presentmentCurrencyCode
      processedAt
      productNetwork
      publication {
        app
        autoPublish
        catalog
        id
        name
        operation
        supportsFuturePublishing
      }
      purchasingEntity
      referralCode
      referrerDisplayText
      referrerUrl
      refundDiscrepancySet {
        presentmentMoney
        shopMoney
      }
      refundable
      registeredSourceUrl
      requiresShipping
      restockable
      retailLocation {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      returnStatus
      risk {
        assessments
        recommendation
      }
      riskLevel
      shippingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      shippingLine {
        carrierIdentifier
        code
        currentDiscountedPriceSet
        custom
        deliveryCategory
        discountAllocations
        discountedPrice
        discountedPriceSet
        id
        isRemoved
        originalPrice
        originalPriceSet
        phone
        price
        requestedFulfillmentService
        shippingRateHandle
        source
        taxLines
        title
      }
      shopifyProtect {
        eligibility
        status
      }
      sourceIdentifier
      sourceName
      staffMember {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      subtotalLineItemsQuantity
      subtotalPrice
      subtotalPriceSet {
        presentmentMoney
        shopMoney
      }
      tags
      taxExempt
      taxLines {
        channelLiable
        price
        priceSet
        rate
        ratePercentage
        source
        title
      }
      taxesIncluded
      test
      totalCapturable
      totalCapturableSet {
        presentmentMoney
        shopMoney
      }
      totalCashRoundingAdjustment {
        paymentSet
        refundSet
      }
      totalDiscounts
      totalDiscountsSet {
        presentmentMoney
        shopMoney
      }
      totalOutstandingSet {
        presentmentMoney
        shopMoney
      }
      totalPrice
      totalPriceSet {
        presentmentMoney
        shopMoney
      }
      totalReceived
      totalReceivedSet {
        presentmentMoney
        shopMoney
      }
      totalRefunded
      totalRefundedSet {
        presentmentMoney
        shopMoney
      }
      totalRefundedShippingSet {
        presentmentMoney
        shopMoney
      }
      totalShippingPrice
      totalShippingPriceSet {
        presentmentMoney
        shopMoney
      }
      totalTax
      totalTaxSet {
        presentmentMoney
        shopMoney
      }
      totalTipReceived {
        amount
        currencyCode
      }
      totalTipReceivedSet {
        presentmentMoney
        shopMoney
      }
      totalWeight
      transactionsCount {
        count
        precision
      }
      unpaid
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofCREATED_ATCURRENT_TOTAL_PRICECUSTOMER_NAMEDESTINATIONFINANCIAL_STATUSFULFILLMENT_STATUSIDORDER_NUMBERPO_NUMBERPROCESSED_ATRELEVANCETOTAL_ITEMS_QUANTITYTOTAL_PRICEUPDATED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman` - `query=title:green hoodie` | | cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | | | - `cart_token:abc123` | | channel | string | Filter by the order attribution [`handle`](https://shopify.dev/api/admin-graphql/latest/objects/OrderAttribution#field-OrderAttribution.fields.handle) (`Order.attribution.handle`) field. The legacy channel information [`handle`](https://shopify.dev/api/admin-graphql/latest/objects/ChannelInformation#field-ChannelInformation.fields.channelDefinition.handle) (`ChannelInformation.channelDefinition.handle`) field is deprecated but remains supported during the deprecation period. | | | - `channel:web` - `channel:web,pos` | | channel_id | id | Filter by the channel [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-Channel.fields.id) field. | | | - `channel_id:123` | | chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - `accepted` - `charge_refunded` - `lost` - `needs_response` - `under_review` - `won` | | - `chargeback_status:accepted` | | checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | | | - `checkout_token:abc123` | | confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | | | - `confirmation_number:ABC123` | | created_at | time | Filter by the date and time when the order was created in Shopify's system. | | | - `created_at:'2020-10-21T23:39:20Z'` - `created_at:<now` - `created_at:<=2024` | | credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | | | - `credit_card_last4:1234` | | current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | | | - `current_total_price:10` - `current_total_price:>=5.00 current_total_price:<=20.99` | | customer_id | id | Filter orders by the customer [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Customer#field-Customer.fields.id) field. | | | - `customer_id:123` | | delivery_method | string | Filter by the delivery [`methodType`](https://shopify.dev/api/admin-graphql/2024-07/objects/DeliveryMethod#field-DeliveryMethod.fields.methodType) field. | - `shipping` - `pick-up` - `retail` - `local` - `pickup-point` - `none` | | - `delivery_method:shipping` | | discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255. | | | - `discount_code:ABC123` | | email | string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | | | - `email:example@shopify.com` | | financial_status | string | Filter by the order [`displayFinancialStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFinancialStatus) field. | - `paid` - `pending` - `authorized` - `partially_paid` - `partially_refunded` - `refunded` - `voided` - `expired` | | - `financial_status:authorized` | | fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - `fully_protected` - `partially_protected` - `not_protected` - `pending` - `not_eligible` - `not_available` | | - `fraud_protection_level:fully_protected` | | fulfillment_location_id | id | Filter by the fulfillment location [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment#field-Fulfillment.fields.location.id) (`Fulfillment.location.id`) field. | | | - `fulfillment_location_id:123` | | fulfillment_status | string | Filter by the [`displayFulfillmentStatus`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFulfillmentStatus) field to prioritize shipments or monitor order processing. | - `unshipped` - `shipped` - `fulfilled` - `partial` - `scheduled` - `on_hold` - `unfulfilled` - `request_declined` | | - `fulfillment_status:fulfilled` | | gateway | string | Filter by the [`paymentGatewayNames`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.paymentGatewayNames) field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. | | | - `gateway:shopify_payments` | | id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` | | location_id | id | Filter by the location [`id`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location#field-Location.fields.id) that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under **Settings** > **Locations**. If no ID is provided, then the primary location of the shop is returned. | | | - `location_id:123` | | metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about [querying by metafield value](https://shopify.dev/apps/build/custom-data/metafields/query-by-metafield-value). | | | - `metafields.custom.on_sale:true` - `metafields.product.material:"gid://shopify/Metaobject/43458085"` | | name | string | Filter by the order [`name`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-name) field. | | | - `name:1001-A` | | payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | | | - `payment_id:abc123` | | payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | | | - `payment_provider_id:123` | | po_number | string | Filter by the order [`poNumber`](https://shopify.dev/api/admin-graphql/latest/objects/order#field-Order.fields.poNumber) field. | | | - `po_number:P01001` | | processed_at | time | Filter by the order [`processedAt`](https://shopify.dev/api/admin-graphql/latest/objects/order#field-Order.fields.processedAt) field. | | | - `processed_at:'2021-01-01T00:00:00Z'` | | reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | | | - `reference_location_id:123` | | return_status | string | Filter by the order's [`returnStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-Order.fields.returnStatus) to monitor returns processing and track which orders have active returns. | - `return_requested` - `in_progress` - `inspection_complete` - `returned` - `return_failed` - `no_return` | | - `return_status:in_progress` | | risk_level | string | Filter by the order risk assessment [`riskLevel`](https://shopify.dev/api/admin-graphql/latest/objects/OrderRiskAssessment#field-OrderRiskAssessment.fields.riskLevel) field. | - `high` - `medium` - `low` - `none` - `pending` | | - `risk_level:high` | | sales_channel | string | Filter by the [sales channel](https://shopify.dev/docs/apps/build/sales-channels) where the order was made to analyze performance or manage fulfillment processes. | | | - `sales_channel: some_sales_channel` | | sku | string | Filter by the product variant [`sku`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-ProductVariant.fields.sku) field. [Learn more about SKUs](https://help.shopify.com/manual/products/details/sku). | | | - `sku:ABC123` | | source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | | | - `source_identifier:1234-12-1000` | | source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | | | - `source_name:web` - `source_name:shopify_draft_order` | | status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - `open` - `closed` - `cancelled` - `not_closed` | | - `status:open` | | subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | | | - `subtotal_line_items_quantity:10` - `subtotal_line_items_quantity:5..20` | | tag | string | Filter objects by the `tag` field. | | | - `tag:my_tag` | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - `tag_not:my_tag` | | test | boolean | Filter by test orders. Test orders are made using the [Shopify Bogus Gateway](https://help.shopify.com/manual/checkout-settings/test-orders/payments-test-mode#bogus-gateway) or a payment provider with test mode enabled. | | | - `test:true` | | total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | | | - `total_weight:10.5kg` - `total_weight:>=5g total_weight:<=20g` - `total_weight:.5 lb` | | updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | | | - `updated_at:'2020-10-21T23:39:20Z'` - `updated_at:<now` - `updated_at:<=2024` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

savedSearchIdstring

The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "CREATED_AT",
  "query": "string",
  "savedSearchId": "string"
}

Response

Read the result with {{orders.response.data.data.orders}}. If the API returns errors, the step fails and they are at {{orders.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

additionalFeesobject

alertsobject

appobject

attributionobject

billingAddressobject

billingAddressMatchesShippingAddressobject

canMarkAsPaidobject

canNotifyCustomerobject

cancelReasonobject

cancellationobject

cancelledAtobject

capturableobject

cartDiscountAmountobject

cartDiscountAmountSetobject

cartTokenobject

channelobject

channelInformationobject

checkoutTokenobject

clientIpobject

closedobject

closedAtobject

confirmationNumberobject

confirmedobject

createdAtobject

currencyCodeobject

currentCartDiscountAmountSetobject

currentShippingPriceSetobject

currentSubtotalLineItemsQuantityobject

currentSubtotalPriceSetobject

currentTaxLinesobject

currentTotalAdditionalFeesSetobject

currentTotalDiscountsSetobject

currentTotalDutiesSetobject

currentTotalPriceSetobject

currentTotalTaxSetobject

currentTotalWeightobject

customAttributesobject

customerobject

customerAcceptsMarketingobject

customerJourneyobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?