Menu
giftCardSendNotificationToRecipient
Sends a notification to the designated recipient of a gift card, delivering the gift card code and redemption instructions.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the giftCardSendNotificationToRecipient action (under Gift).
- Fill in the fields below, then reference the result from later steps as
{{giftcardsendnotificationtorecipient.response.data}}.
Query
This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.
mutation GiftCardSendNotificationToRecipient($id: ID!) {
giftCardSendNotificationToRecipient(id: $id) {
giftCard {
balance {
amount
currencyCode
}
createdAt
crossCurrencyRedemptionStrategy
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
}
deactivatedAt
enabled
expiresOn
id
initialValue {
amount
currencyCode
}
isRedeemable
lastCharacters
lineItem {
canRestock
contract
currentQuantity
customAttributes
discountAllocations
discountedTotal
discountedUnitPrice
discountedUnitPriceAfterAllDiscountsSet
discountedUnitPriceSet
duties
fulfillableQuantity
fulfillmentService
fulfillmentStatus
id
isGiftCard
lineItemGroup
merchantEditable
name
nonFulfillableQuantity
originalTotal
originalTotalSet
originalUnitPrice
originalUnitPriceSet
priceAfterAllDiscountsBeforeTaxesSet
product
quantity
refundableQuantity
requiresShipping
restockable
sellingPlan
sku
staffMember
taxable
title
totalDiscount
totalDiscountSet
unfulfilledDiscountedTotal
unfulfilledDiscountedTotalSet
unfulfilledOriginalTotal
unfulfilledOriginalTotalSet
unfulfilledQuantity
variant
variantTitle
vendor
weight
}
maskedCode
note
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
}
recipientAttributes {
message
preferredName
recipient
sendNotificationAt
}
templateSuffix
updatedAt
}
userErrors {
code
field
message
}
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"id": "string"
}
Response
Read the result with {{giftcardsendnotificationtorecipient.response.data.data.giftCardSendNotificationToRecipient}}. If the API returns errors, the step fails and they are at {{giftcardsendnotificationtorecipient.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?