---
title: draftOrderInvoicePreview - GraphQL Admin
description: Previews a draft order invoice email.
api_version: 2025-10
api_name: admin
type: mutation
api_type: graphql
source_url:
html: https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftorderinvoicepreview
md: https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftorderinvoicepreview.md
---
# draftOrderInvoicePreview
mutation
Requires `write_draft_orders` access scope.
Previews a draft order invoice email.
## Arguments
* email
[EmailInput](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/EmailInput)
Specifies the draft order invoice email fields.
* id
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
required
Specifies the draft order invoice email to preview.
***
## DraftOrderInvoicePreviewPayload returns
* previewHtml
[HTML](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML)
The draft order invoice email rendered as HTML to allow previewing.
* previewSubject
[HTML](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML)
The subject preview for the draft order invoice email.
* userErrors
[\[UserError!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/UserError)
non-null
The list of errors that occurred from executing the mutation.
***
## Examples
* ### Preview a draft order invoice by draft order ID
#### Query
```graphql
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}
```
#### Variables
```json
{
"id": "gid://shopify/DraftOrder/276395349"
}
```
#### cURL
```bash
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderInvoicePreview($id: ID!) { draftOrderInvoicePreview(id: $id) { previewHtml previewSubject } }",
"variables": {
"id": "gid://shopify/DraftOrder/276395349"
}
}'
```
#### React Router
```javascript
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}`,
{
variables: {
"id": "gid://shopify/DraftOrder/276395349"
},
},
);
const json = await response.json();
return json.data;
}
```
#### Ruby
```ruby
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}
QUERY
variables = {
"id": "gid://shopify/DraftOrder/276395349"
}
response = client.query(query: query, variables: variables)
```
#### Node.js
```javascript
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}`,
"variables": {
"id": "gid://shopify/DraftOrder/276395349"
},
},
});
```
#### Response
```json
{
"draftOrderInvoicePreview": {
"previewHtml": "\n\nInvoice #D1 from Snowdevil
\n\n\n",
"previewSubject": "Draft Order #D1"
}
}
```
* ### Preview a draft order invoice with custom email input
#### Query
```graphql
mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {
draftOrderInvoicePreview(id: $id, email: $email) {
previewHtml
previewSubject
}
}
```
#### Variables
```json
{
"id": "gid://shopify/DraftOrder/276395349",
"email": {
"to": "test@example.com",
"subject": "Custom subject",
"customMessage": "Hi,\nThis is a custom message for the customer."
}
}
```
#### cURL
```bash
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) { draftOrderInvoicePreview(id: $id, email: $email) { previewHtml previewSubject } }",
"variables": {
"id": "gid://shopify/DraftOrder/276395349",
"email": {
"to": "test@example.com",
"subject": "Custom subject",
"customMessage": "Hi,\nThis is a custom message for the customer."
}
}
}'
```
#### React Router
```javascript
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {
draftOrderInvoicePreview(id: $id, email: $email) {
previewHtml
previewSubject
}
}`,
{
variables: {
"id": "gid://shopify/DraftOrder/276395349",
"email": {
"to": "test@example.com",
"subject": "Custom subject",
"customMessage": "Hi,\nThis is a custom message for the customer."
}
},
},
);
const json = await response.json();
return json.data;
}
```
#### Ruby
```ruby
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {
draftOrderInvoicePreview(id: $id, email: $email) {
previewHtml
previewSubject
}
}
QUERY
variables = {
"id": "gid://shopify/DraftOrder/276395349",
"email": {
"to": "test@example.com",
"subject": "Custom subject",
"customMessage": "Hi,\nThis is a custom message for the customer."
}
}
response = client.query(query: query, variables: variables)
```
#### Node.js
```javascript
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {
draftOrderInvoicePreview(id: $id, email: $email) {
previewHtml
previewSubject
}
}`,
"variables": {
"id": "gid://shopify/DraftOrder/276395349",
"email": {
"to": "test@example.com",
"subject": "Custom subject",
"customMessage": "Hi,\nThis is a custom message for the customer."
}
},
},
});
```
#### Response
```json
{
"draftOrderInvoicePreview": {
"previewHtml": "\n\nInvoice #D1 from Snowdevil
\nHi,
This is a custom message for the customer.
\n\n",
"previewSubject": "Custom subject"
}
}
```
* ### Previewing a completed draft order returns an error
#### Query
```graphql
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
userErrors {
message
field
}
}
}
```
#### Variables
```json
{
"id": "gid://shopify/DraftOrder/989355118"
}
```
#### cURL
```bash
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderInvoicePreview($id: ID!) { draftOrderInvoicePreview(id: $id) { previewHtml userErrors { message field } } }",
"variables": {
"id": "gid://shopify/DraftOrder/989355118"
}
}'
```
#### React Router
```javascript
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
userErrors {
message
field
}
}
}`,
{
variables: {
"id": "gid://shopify/DraftOrder/989355118"
},
},
);
const json = await response.json();
return json.data;
}
```
#### Ruby
```ruby
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
userErrors {
message
field
}
}
}
QUERY
variables = {
"id": "gid://shopify/DraftOrder/989355118"
}
response = client.query(query: query, variables: variables)
```
#### Node.js
```javascript
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
userErrors {
message
field
}
}
}`,
"variables": {
"id": "gid://shopify/DraftOrder/989355118"
},
},
});
```
#### Response
```json
{
"draftOrderInvoicePreview": {
"previewHtml": null,
"userErrors": [
{
"message": "Draft order Invoice can't be sent. This draft order is already paid.",
"field": null
}
]
}
}
```
* ### draftOrderInvoicePreview reference
[Open in GraphiQL](http://localhost:3457/graphiql?query=mutation%20draftOrderInvoicePreview\(%24id%3A%20ID!\)%20%7B%0A%20%20draftOrderInvoicePreview\(id%3A%20%24id\)%20%7B%0A%20%20%20%20previewHtml%0A%20%20%20%20previewSubject%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22id%22%3A%20%22gid%3A%2F%2Fshopify%2FDraftOrder%2F276395349%22%0A%7D)
```javascript
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}`,
{
variables: {
"id": "gid://shopify/DraftOrder/276395349"
},
},
);
const json = await response.json();
return json.data;
}
```
##### GQL
```
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}
```
##### cURL
```
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderInvoicePreview($id: ID!) { draftOrderInvoicePreview(id: $id) { previewHtml previewSubject } }",
"variables": {
"id": "gid://shopify/DraftOrder/276395349"
}
}'
```
##### React Router
```
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}`,
{
variables: {
"id": "gid://shopify/DraftOrder/276395349"
},
},
);
const json = await response.json();
return json.data;
}
```
##### Node.js
```
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}`,
"variables": {
"id": "gid://shopify/DraftOrder/276395349"
},
},
});
```
##### Ruby
```
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation draftOrderInvoicePreview($id: ID!) {
draftOrderInvoicePreview(id: $id) {
previewHtml
previewSubject
}
}
QUERY
variables = {
"id": "gid://shopify/DraftOrder/276395349"
}
response = client.query(query: query, variables: variables)
```
## Input variables
JSON
```json
{
"id": "gid://shopify/DraftOrder/276395349"
}
```
## Response
JSON
```json
{
"draftOrderInvoicePreview": {
"previewHtml": "\n\nInvoice #D1 from Snowdevil
\n\n\n",
"previewSubject": "Draft Order #D1"
}
}
```