Menu
orderByIdentifier
Fetch a single order by its ID.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the orderByIdentifier action (under Order).
- Fill in the fields below, then reference the result from later steps as
{{orderbyidentifier.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.
query OrderByIdentifier($identifier: OrderIdentifierInput!) {
orderByIdentifier(identifier: $identifier) {
additionalFees {
id
name
price {
presentmentMoney
shopMoney
}
taxLines {
channelLiable
price
priceSet
rate
ratePercentage
source
title
}
}
alerts {
actions {
primary
show
title
url
}
content
dismissibleHandle
icon
severity
title
}
app {
icon {
altText
height
id
originalSrc
src
thumbhash
width
}
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 {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
cartToken
channel {
accountId
accountName
activeRegions
app {
apiKey
appStoreAppUrl
appStoreDeveloperUrl
availableAccessScopes
banner
description
developerName
developerType
developerUrl
embedded
failedRequirements
features
feedback
handle
icon
id
installUrl
installation
isPostPurchaseAppInUse
launchUrl
navigationItems
optionalAccessScopes
previouslyInstalled
pricingDetails
pricingDetailsSummary
privacyPolicyUrl
publicCategory
published
requestedAccessScopes
screenshots
shopifyDeveloped
title
uninstallMessage
uninstallUrl
webhookApiVersion
}
handle
id
marketsCount {
count
precision
}
name
navigationItems {
id
title
url
}
overviewPath
resourceFeedback {
app
channel
feedbackGeneratedAt
link
messages
state
}
specificationHandle
supportsFuturePublishing
}
channelInformation {
app {
apiKey
appStoreAppUrl
appStoreDeveloperUrl
availableAccessScopes
banner
description
developerName
developerType
developerUrl
embedded
failedRequirements
features
feedback
handle
icon
id
installUrl
installation
isPostPurchaseAppInUse
launchUrl
navigationItems
optionalAccessScopes
previouslyInstalled
pricingDetails
pricingDetailsSummary
privacyPolicyUrl
publicCategory
published
requestedAccessScopes
screenshots
shopifyDeveloped
title
uninstallMessage
uninstallUrl
webhookApiVersion
}
channelDefinition {
channelName
handle
id
isMarketplace
subChannelName
svgIcon
}
channelId
displayName
id
}
checkoutToken
clientIp
closed
closedAt
confirmationNumber
confirmed
createdAt
currencyCode
currentCartDiscountAmountSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentShippingPriceSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentSubtotalLineItemsQuantity
currentSubtotalPriceSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentTaxLines {
channelLiable
price
priceSet {
presentmentMoney
shopMoney
}
rate
ratePercentage
source
title
}
currentTotalAdditionalFeesSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentTotalDiscountsSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentTotalDutiesSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentTotalPriceSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentTotalTaxSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
currentTotalWeight
customAttributes {
key
value
}
customer {
amountSpent {
amount
currencyCode
}
canDelete
companyContactProfiles {
company
createdAt
customer
id
isMainContact
lifetimeDuration
locale
title
updatedAt
}
createdAt
dataSaleOptOut
defaultAddress {
address1
address2
city
company
coordinatesValidated
country
countryCode
countryCodeV2
firstName
formattedArea
id
lastName
latitude
longitude
name
phone
province
provinceCode
timeZone
validationResultSummary
zip
}
defaultEmailAddress {
emailAddress
marketingOptInLevel
marketingState
marketingUnsubscribeUrl
marketingUpdatedAt
openTrackingLevel
openTrackingUrl
sourceLocation
validFormat
}
defaultPhoneNumber {
marketingCollectedFrom
marketingOptInLevel
marketingState
marketingUpdatedAt
phoneNumber
sourceLocation
whatsAppMarketingConsent
}
displayName
email
emailMarketingConsent {
consentUpdatedAt
marketingOptInLevel
marketingState
sourceLocation
}
firstName
hasTimelineComment
id
identityProviderSubjects {
createdAt
id
providerName
subject
updatedAt
}
lastName
lastOrder
legacyResourceId
lifetimeDuration
locale
market {
catalogsCount
conditions
currencySettings
delivery
discountsCount
enabled
handle
id
name
priceInclusions
priceList
primary
status
type
webPresence
}
mergeable {
errorFields
isMergeable
mergeInProgress
reason
}
multipassIdentifier
note
numberOfOrders
phone
productSubscriberStatus
smsMarketingConsent {
consentCollectedFrom
consentUpdatedAt
marketingOptInLevel
marketingState
sourceLocation
}
state
statistics {
predictedSpendTier
rfmGroup
}
tags
taxExempt
taxExemptions
taxSettings {
taxId
}
unsubscribeUrl
updatedAt
validEmailAddress
verifiedEmail
}
customerAcceptsMarketing
customerJourney {
customerOrderIndex
daysToConversion
firstVisit {
id
landingPage
landingPageHtml
marketingEvent
occurredAt
referralCode
referralInfoHtml
referrerUrl
source
sourceDescription
sourceType
utmParameters
}
lastVisit {
id
landingPage
landingPageHtml
marketingEvent
occurredAt
referralCode
referralInfoHtml
referrerUrl
source
sourceDescription
sourceType
utmParameters
}
moments {
occurredAt
}
}
customerJourneySummary {
customerOrderIndex
daysToConversion
firstVisit {
id
landingPage
landingPageHtml
marketingEvent
occurredAt
referralCode
referralInfoHtml
referrerUrl
source
sourceDescription
sourceType
utmParameters
}
lastVisit {
id
landingPage
landingPageHtml
marketingEvent
occurredAt
referralCode
referralInfoHtml
referrerUrl
source
sourceDescription
sourceType
utmParameters
}
momentsCount {
count
precision
}
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 {
address1
address2
city
countryCode
province
zip
}
archived
companyName
displayName
id
legalEntityId
primary
shopifyPaymentsAccount {
accountOpenerName
activated
balance
chargeStatementDescriptor
chargeStatementDescriptors
country
defaultCurrency
id
onboardable
payoutSchedule
payoutStatementDescriptor
}
}
merchantEditable
merchantEditableErrors
merchantOfRecordApp {
icon {
altText
height
id
originalSrc
src
thumbhash
width
}
id
name
}
name
netPayment
netPaymentSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
note
number
originalTotalAdditionalFeesSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
originalTotalDutiesSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
originalTotalPriceSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
paymentCollectionDetails {
additionalPaymentCollectionUrl
vaultedPaymentMethods {
id
paymentInstrument
}
}
paymentGatewayNames
paymentTerms {
draftOrder {
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
}
due
dueInDays
id
order
overdue
paymentTermsName
paymentTermsType
translatedName
}
phone
physicalLocation {
activatable
address {
address1
address2
city
country
countryCode
formatted
latitude
longitude
phone
province
provinceCode
zip
}
addressVerified
createdAt
deactivatable
deactivatedAt
deletable
fulfillmentService {
callbackUrl
fulfillmentOrdersOptIn
handle
id
inventoryManagement
location
requiresShippingMethod
serviceName
trackingSupport
type
}
fulfillsOnlineOrders
hasActiveInventory
hasUnfulfilledOrders
id
isActive
isFulfillmentService
isPrimary
legacyResourceId
localPickupSettingsV2 {
instructions
pickupTime
}
name
shipsInventory
suggestedAddresses {
address1
address2
city
country
countryCode
formatted
province
provinceCode
zip
}
updatedAt
}
poNumber
presentmentCurrencyCode
processedAt
productNetwork
publication {
app {
apiKey
appStoreAppUrl
appStoreDeveloperUrl
availableAccessScopes
banner
description
developerName
developerType
developerUrl
embedded
failedRequirements
features
feedback
handle
icon
id
installUrl
installation
isPostPurchaseAppInUse
launchUrl
navigationItems
optionalAccessScopes
previouslyInstalled
pricingDetails
pricingDetailsSummary
privacyPolicyUrl
publicCategory
published
requestedAccessScopes
screenshots
shopifyDeveloped
title
uninstallMessage
uninstallUrl
webhookApiVersion
}
autoPublish
catalog {
id
operations
priceList
publication
status
title
}
id
name
operation
supportsFuturePublishing
}
purchasingEntity
referralCode
referrerDisplayText
referrerUrl
refundDiscrepancySet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
refundable
registeredSourceUrl
requiresShipping
restockable
retailLocation {
activatable
address {
address1
address2
city
country
countryCode
formatted
latitude
longitude
phone
province
provinceCode
zip
}
addressVerified
createdAt
deactivatable
deactivatedAt
deletable
fulfillmentService {
callbackUrl
fulfillmentOrdersOptIn
handle
id
inventoryManagement
location
requiresShippingMethod
serviceName
trackingSupport
type
}
fulfillsOnlineOrders
hasActiveInventory
hasUnfulfilledOrders
id
isActive
isFulfillmentService
isPrimary
legacyResourceId
localPickupSettingsV2 {
instructions
pickupTime
}
name
shipsInventory
suggestedAddresses {
address1
address2
city
country
countryCode
formatted
province
provinceCode
zip
}
updatedAt
}
returnStatus
risk {
assessments {
facts
provider
riskLevel
}
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 {
presentmentMoney
shopMoney
}
custom
deliveryCategory
discountAllocations {
allocatedAmount
allocatedAmountSet
discountApplication
}
discountedPrice {
amount
currencyCode
}
discountedPriceSet {
presentmentMoney
shopMoney
}
id
isRemoved
originalPrice {
amount
currencyCode
}
originalPriceSet {
presentmentMoney
shopMoney
}
phone
price
requestedFulfillmentService {
callbackUrl
fulfillmentOrdersOptIn
handle
id
inventoryManagement
location
requiresShippingMethod
serviceName
trackingSupport
type
}
shippingRateHandle
source
taxLines {
channelLiable
price
priceSet
rate
ratePercentage
source
title
}
title
}
shopifyProtect {
eligibility {
status
}
status
}
sourceIdentifier
sourceName
staffMember {
accountType
active
email
exists
firstName
id
initials
isShopOwner
lastName
locale
name
phone
privateData {
accountSettingsUrl
createdAt
permissions
}
}
subtotalLineItemsQuantity
subtotalPrice
subtotalPriceSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
tags
taxExempt
taxLines {
channelLiable
price
priceSet {
presentmentMoney
shopMoney
}
rate
ratePercentage
source
title
}
taxesIncluded
test
totalCapturable
totalCapturableSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalCashRoundingAdjustment {
paymentSet {
presentmentMoney
shopMoney
}
refundSet {
presentmentMoney
shopMoney
}
}
totalDiscounts
totalDiscountsSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalOutstandingSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalPrice
totalPriceSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalReceived
totalReceivedSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalRefunded
totalRefundedSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalRefundedShippingSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalShippingPrice
totalShippingPriceSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalTax
totalTaxSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalTipReceived {
amount
currencyCode
}
totalTipReceivedSet {
presentmentMoney {
amount
currencyCode
}
shopMoney {
amount
currencyCode
}
}
totalWeight
transactionsCount {
count
precision
}
unpaid
updatedAt
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"identifier": {
"id": "string",
"customId": {
"key": "string",
"value": "string",
"namespace": "string"
}
}
}
Response
Read the result with {{orderbyidentifier.response.data.data.orderByIdentifier}}. If the API returns errors, the step fails and they are at {{orderbyidentifier.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?