Menu
draftOrderCreate
Creates a draft order with attributes such as customer information, line items, shipping and billing addresses, and payment terms.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the draftOrderCreate action (under Draft).
- Fill in the fields below, then reference the result from later steps as
{{draftordercreate.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 DraftOrderCreate($input: DraftOrderInput!) {
draftOrderCreate(input: $input) {
draftOrder {
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
}
}
userErrors {
field
message
}
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"input": {
"appliedDiscount": {
"value": 0,
"valueType": "FIXED_AMOUNT",
"amount": "string",
"amountWithCurrency": {
"amount": "string",
"currencyCode": "string"
},
"description": "string",
"title": "string"
},
"discountCodes": [
"string"
],
"acceptAutomaticDiscounts": false,
"billingAddress": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"countryCode": "AF",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string",
"province": "string",
"provinceCode": "string"
},
"customerId": "string",
"customAttributes": [
{
"key": "string",
"value": "string"
}
],
"email": "string",
"lineItems": [
{
"quantity": "string",
"appliedDiscount": "string",
"customAttributes": "string",
"grams": "string",
"originalUnitPrice": "string",
"originalUnitPriceWithCurrency": "string",
"requiresShipping": "string",
"sku": "string",
"taxable": "string",
"title": "string",
"variantId": "string",
"weight": "string"
}
],
"metafields": [
{
"id": "string",
"namespace": "string",
"key": "string",
"value": "string",
"type": "string"
}
],
"localizationExtensions": [
{
"key": "string",
"value": "string"
}
],
"localizedFields": [
{
"key": "string",
"value": "string"
}
],
"note": "string"
}
}
Response
Read the result with {{draftordercreate.response.data.data.draftOrderCreate}}. If the API returns errors, the step fails and they are at {{draftordercreate.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?