Anchor to section titled 'undefined'

draftOrderInvoicePreview
mutation

Requires write_draft_orders access scope.

Previews a draft order invoice email.


Specifies the draft order invoice email fields.

Anchor to id
id
required

Specifies the draft order invoice email to preview.


Was this section helpful?

The draft order invoice email rendered as HTML to allow previewing.

The subject preview for the draft order invoice email.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
Copy
mutation draftOrderInvoicePreview($id: ID!) {
  draftOrderInvoicePreview(id: $id) {
    previewHtml
    previewSubject
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-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();
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)
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"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "id": "gid://shopify/DraftOrder/276395349"
}
Hide code
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"
  }
}