# draftOrderInvoicePreview - admin-graphql - MUTATION
Version: 2024-10
## Description
Previews a draft order invoice email.
### Access Scopes
`write_draft_orders` access scope.
## Arguments
* [email](/docs/api/admin-graphql/2024-10/input-objects/EmailInput): EmailInput - Specifies the draft order invoice email fields.
* [id](/docs/api/admin-graphql/2024-10/scalars/ID): ID! - Specifies the draft order invoice email to preview.
## Returns
* [previewHtml](/docs/api/admin-graphql/2024-10/scalars/HTML): HTML The draft order invoice email rendered as HTML to allow previewing.
* [previewSubject](/docs/api/admin-graphql/2024-10/scalars/HTML): HTML The subject preview for the draft order invoice email.
* [userErrors](/docs/api/admin-graphql/2024-10/objects/UserError): UserError! The list of errors that occurred from executing the mutation.
## Examples
### Preview a draft order invoice by draft order ID
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderInvoicePreview($id: ID!) { draftOrderInvoicePreview(id: $id) { previewHtml previewSubject } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n previewSubject\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n },\n },\n});\n"
Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n previewSubject\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n previewSubject\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n },\n },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n previewSubject\n }\n}"
#### Graphql Input
{
"id": "gid://shopify/DraftOrder/276395349"
}
#### Graphql Response
{
"data": {
"draftOrderInvoicePreview": {
"previewHtml": "\n\nInvoice #D1 from Snowdevil
\n\n\n",
"previewSubject": "Draft Order #D1"
}
}
}
### Preview a draft order invoice with custom email input
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) { draftOrderInvoicePreview(id: $id, email: $email) { previewHtml previewSubject } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"to\": \"test@example.com\",\n \"subject\": \"Custom subject\",\n \"customMessage\": \"Hi,\\nThis is a custom message for the customer.\"\n }\n }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {\n draftOrderInvoicePreview(id: $id, email: $email) {\n previewHtml\n previewSubject\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"to\": \"test@example.com\",\n \"subject\": \"Custom subject\",\n \"customMessage\": \"Hi,\\nThis is a custom message for the customer.\"\n }\n },\n },\n});\n"
Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {\n draftOrderInvoicePreview(id: $id, email: $email) {\n previewHtml\n previewSubject\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"to\": \"test@example.com\",\n \"subject\": \"Custom subject\",\n \"customMessage\": \"Hi,\nThis is a custom message for the customer.\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {\n draftOrderInvoicePreview(id: $id, email: $email) {\n previewHtml\n previewSubject\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"to\": \"test@example.com\",\n \"subject\": \"Custom subject\",\n \"customMessage\": \"Hi,\\nThis is a custom message for the customer.\"\n }\n },\n },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {\n draftOrderInvoicePreview(id: $id, email: $email) {\n previewHtml\n previewSubject\n }\n}"
#### Graphql Input
{
"id": "gid://shopify/DraftOrder/276395349",
"email": {
"to": "test@example.com",
"subject": "Custom subject",
"customMessage": "Hi,\nThis is a custom message for the customer."
}
}
#### Graphql Response
{
"data": {
"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
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderInvoicePreview($id: ID!) { draftOrderInvoicePreview(id: $id) { previewHtml userErrors { message field } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/989355118\"\n }\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/989355118\"\n },\n },\n});\n"
Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DraftOrder/989355118\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/989355118\"\n },\n },\n);\n\nconst data = await response.json();\n"
Graphql query: "mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n userErrors {\n message\n field\n }\n }\n}"
#### Graphql Input
{
"id": "gid://shopify/DraftOrder/989355118"
}
#### Graphql Response
{
"data": {
"draftOrderInvoicePreview": {
"previewHtml": null,
"userErrors": [
{
"message": "Draft order Invoice can't be sent. This draft order is already paid.",
"field": null
}
]
}
}
}