draftOrders

Query draft orders — supports a search `query`, `sortKey`, and cursor paging.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the draftOrders action (under Draft).
Fill in the fields below, then reference the result from later steps as {{draftorders.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 DraftOrders($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: DraftOrderSortKeys, $query: String, $savedSearchId: ID) {
  draftOrders(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
    savedSearchId: $savedSearchId
  ) {
    edges {
      cursor
      node {
        acceptAutomaticDiscounts
        allVariantPricesOverridden
        allowDiscountCodesInCheckout
        amountDueLaterSet
        amountDueNowSet
        anyVariantPricesOverridden
        appliedDiscount
        billingAddress
        billingAddressMatchesShippingAddress
        completedAt
        createdAt
        currencyCode
        customAttributes
        customer
        defaultCursor
        deposit
        discountCodes
        email
        hasTimelineComment
        id
        invoiceEmailTemplateSubject
        invoiceSentAt
        invoiceUrl
        legacyResourceId
        lineItemsSubtotalPrice
        marketName
        marketRegionCountryCode
        name
        note2
        order
        paymentTerms
        phone
        platformDiscounts
        poNumber
        presentmentCurrencyCode
        purchasingEntity
        ready
        reserveInventoryUntil
        shippingAddress
        shippingLine
        status
        subtotalPrice
        subtotalPriceSet
        tags
        taxExempt
        taxLines
        taxesIncluded
        totalDiscountsSet
        totalLineItemsPriceSet
        totalPrice
        totalPriceSet
        totalQuantityOfLineItems
        totalShippingPrice
        totalShippingPriceSet
        totalTax
        totalTaxSet
        totalWeight
        transformerFingerprint
        updatedAt
        visibleToCustomer
        warnings
      }
    }
    nodes {
      acceptAutomaticDiscounts
      allVariantPricesOverridden
      allowDiscountCodesInCheckout
      amountDueLaterSet {
        presentmentMoney
        shopMoney
      }
      amountDueNowSet {
        presentmentMoney
        shopMoney
      }
      anyVariantPricesOverridden
      appliedDiscount {
        amount
        amountSet
        amountV2
        description
        title
        value
        valueType
      }
      billingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      billingAddressMatchesShippingAddress
      completedAt
      createdAt
      currencyCode
      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
      }
      defaultCursor
      deposit
      discountCodes
      email
      hasTimelineComment
      id
      invoiceEmailTemplateSubject
      invoiceSentAt
      invoiceUrl
      legacyResourceId
      lineItemsSubtotalPrice {
        presentmentMoney
        shopMoney
      }
      marketName
      marketRegionCountryCode
      name
      note2
      order {
        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
      }
      paymentTerms {
        draftOrder
        due
        dueInDays
        id
        order
        overdue
        paymentTermsName
        paymentTermsType
        translatedName
      }
      phone
      platformDiscounts {
        allocations
        automaticDiscount
        bxgyDiscount
        code
        discountClass
        discountClasses
        discountNode
        id
        presentationLevel
        shortSummary
        summary
        title
        totalAmount
        totalAmountPriceSet
      }
      poNumber
      presentmentCurrencyCode
      purchasingEntity
      ready
      reserveInventoryUntil
      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
      }
      status
      subtotalPrice
      subtotalPriceSet {
        presentmentMoney
        shopMoney
      }
      tags
      taxExempt
      taxLines {
        channelLiable
        price
        priceSet
        rate
        ratePercentage
        source
        title
      }
      taxesIncluded
      totalDiscountsSet {
        presentmentMoney
        shopMoney
      }
      totalLineItemsPriceSet {
        presentmentMoney
        shopMoney
      }
      totalPrice
      totalPriceSet {
        presentmentMoney
        shopMoney
      }
      totalQuantityOfLineItems
      totalShippingPrice
      totalShippingPriceSet {
        presentmentMoney
        shopMoney
      }
      totalTax
      totalTaxSet {
        presentmentMoney
        shopMoney
      }
      totalWeight
      transformerFingerprint
      updatedAt
      visibleToCustomer
      warnings {
        errorCode
        field
        message
      }
    }
    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 ofCUSTOMER_NAMEIDNUMBERRELEVANCESTATUSTOTAL_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`<br/> - `query=title:green hoodie` | | created_at | time | | customer_id | id | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | source | string | | status | string | | tag | string | | updated_at | time | 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": "CUSTOMER_NAME",
  "query": "string",
  "savedSearchId": "string"
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

acceptAutomaticDiscountsobject

allVariantPricesOverriddenobject

allowDiscountCodesInCheckoutobject

amountDueLaterSetobject

amountDueNowSetobject

anyVariantPricesOverriddenobject

appliedDiscountobject

billingAddressobject

billingAddressMatchesShippingAddressobject

completedAtobject

createdAtobject

currencyCodeobject

customAttributesobject

customerobject

defaultCursorobject

depositobject

discountCodesobject

emailobject

hasTimelineCommentobject

idobject

invoiceEmailTemplateSubjectobject

invoiceSentAtobject

invoiceUrlobject

legacyResourceIdobject

lineItemsSubtotalPriceobject

marketNameobject

marketRegionCountryCodeobject

nameobject

note2object

orderobject

paymentTermsobject

phoneobject

platformDiscountsobject

poNumberobject

presentmentCurrencyCodeobject

purchasingEntityobject

readyobject

reserveInventoryUntilobject

shippingAddressobject

shippingLineobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?