Choose a version:

draftOrderInvoicePreview

mutation

Requires write_draft_orders access scope.

Previews a draft order invoice email.

Arguments

Anchor to emailemail • EmailInput: Specifies the draft order invoice email fields.
Anchor to idid • ID!required: Specifies the draft order invoice email to preview.

Was this section helpful?

Anchor to DraftOrderInvoicePreviewPayload returnsDraftOrderInvoicePreviewPayload returns

Anchor to previewHtmlpreviewHtml • HTML: The draft order invoice email rendered as HTML to allow previewing.
Anchor to previewSubjectpreviewSubject • HTML: The subject preview for the draft order invoice email.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Preview a draft order invoice by draft order ID
Preview a draft order invoice with custom email input
Previewing a completed draft order returns an error
draftOrderInvoicePreview reference

Examples

Open in GraphiQL

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 data = await response.json();

mutation draftOrderInvoicePreview($id: ID!) {
  draftOrderInvoicePreview(id: $id) {
    previewHtml
    previewSubject
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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"
  }
}'

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 data = await response.json();

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"
    },
  },
});

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

{

"id": "gid://shopify/DraftOrder/276395349"

}

Response

JSON

{

"draftOrderInvoicePreview": {

"previewHtml": "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">\n<html><body>\n<p>Invoice #D1 from Snowdevil</p>\n<p></p>\n</body></html>\n",

"previewSubject": "Draft Order #D1"

}