Menu
giftCard
Retrieves a GiftCard by its ID. Returns the gift card's balance, transaction history, Customer information, and whether it's enabled.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the giftCard action (under Gift).
- Fill in the fields below, then reference the result from later steps as
{{giftcard.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 GiftCard($id: ID!) {
giftCard(id: $id) {
balance {
amount
currencyCode
}
createdAt
crossCurrencyRedemptionStrategy
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 {
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
}
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
}
deactivatedAt
enabled
expiresOn
id
initialValue {
amount
currencyCode
}
isRedeemable
lastCharacters
lineItem {
canRestock
contract {
app
appAdminUrl
billingPolicy
createdAt
currencyCode
customAttributes
customer
deliveryMethod
deliveryPolicy
deliveryPrice
id
lastBillingAttemptErrorType
lastPaymentStatus
lineCount
linesCount
nextBillingDate
note
originOrder
revisionId
status
updatedAt
}
currentQuantity
customAttributes {
key
value
}
discountAllocations {
allocatedAmount
allocatedAmountSet
discountApplication
}
discountedTotal
discountedUnitPrice
discountedUnitPriceAfterAllDiscountsSet {
presentmentMoney
shopMoney
}
discountedUnitPriceSet {
presentmentMoney
shopMoney
}
duties {
countryCodeOfOrigin
harmonizedSystemCode
id
price
taxLines
}
fulfillableQuantity
fulfillmentService {
callbackUrl
fulfillmentOrdersOptIn
handle
id
inventoryManagement
location
requiresShippingMethod
serviceName
trackingSupport
type
}
fulfillmentStatus
id
isGiftCard
lineItemGroup {
customAttributes
id
productId
quantity
title
variantId
variantSku
}
merchantEditable
name
nonFulfillableQuantity
originalTotal
originalTotalSet {
presentmentMoney
shopMoney
}
originalUnitPrice
originalUnitPriceSet {
presentmentMoney
shopMoney
}
priceAfterAllDiscountsBeforeTaxesSet {
presentmentMoney
shopMoney
}
product {
availablePublicationsCount
bodyHtml
bundleConsolidatedOptions
category
combinedListing
combinedListingRole
compareAtPriceRange
createdAt
customProductType
defaultCursor
descriptionHtml
descriptionPlainSummary
featuredImage
featuredMedia
feedback
giftCardSettings
giftCardTemplateSuffix
handle
hasOnlyDefaultVariant
hasOutOfStockVariants
hasVariantsThatRequiresComponents
id
isGiftCard
legacyResourceId
mediaCount
onlineStorePreviewUrl
onlineStoreUrl
priceRange
priceRangeV2
productCategory
productComponentsCount
productType
publishedAt
publishedOnCurrentChannel
publishedOnCurrentPublication
requiresSellingPlan
resourcePublicationOnCurrentPublication
sellingPlanGroupCount
sellingPlanGroupsCount
seo
standardizedProductType
status
storefrontId
tags
templateSuffix
title
totalInventory
totalVariants
tracksInventory
updatedAt
variantsCount
vendor
}
quantity
refundableQuantity
requiresShipping
restockable
sellingPlan {
name
sellingPlanId
}
sku
staffMember {
accountType
active
email
exists
firstName
id
initials
isShopOwner
lastName
locale
name
phone
privateData
}
taxable
title
totalDiscount
totalDiscountSet {
presentmentMoney
shopMoney
}
unfulfilledDiscountedTotal
unfulfilledDiscountedTotalSet {
presentmentMoney
shopMoney
}
unfulfilledOriginalTotal
unfulfilledOriginalTotalSet {
presentmentMoney
shopMoney
}
unfulfilledQuantity
variant {
availableForSale
availablePublicationsCount
barcode
compareAtPrice
createdAt
defaultCursor
deliveryProfile
displayName
id
inventoryItem
inventoryPolicy
inventoryQuantity
legacyResourceId
position
price
product
publishedOnCurrentChannel
publishedOnCurrentPublication
requiresComponents
selectedOptions
sellableOnlineQuantity
sellingPlanGroupCount
sellingPlanGroupsCount
showUnitPrice
sku
storefrontId
taxCode
taxable
title
unitPrice
unitPriceMeasurement
updatedAt
}
variantTitle
vendor
weight {
unit
value
}
}
maskedCode
note
order {
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
}
recipientAttributes {
message
preferredName
recipient {
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
}
sendNotificationAt
}
templateSuffix
updatedAt
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"id": "string"
}
Response
Read the result with {{giftcard.response.data.data.giftCard}}. If the API returns errors, the step fails and they are at {{giftcard.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?