Anchor to section titled 'undefined'draft
draft
mutation
2024-10latest
Requires write access scope.
Previews a draft order invoice email.
Anchor to section titled 'Arguments'
Arguments
Specifies the draft order invoice email fields.
Specifies the draft order invoice email to preview.
Was this section helpful?
Anchor to section titled 'DraftOrderInvoicePreviewPayload returns'
DraftOrderInvoicePreviewPayload returns
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?
Code examples for MUTATION: draftOrderInvoicePreview
Query Reference for MUTATION: draftOrderInvoicePreview
"mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n previewSubject\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: draftOrderInvoicePreview
"{\n \"email\": {\n \"bcc\": [\n \"<your-bcc>\"\n ],\n \"body\": \"<your-body>\",\n \"customMessage\": \"<your-customMessage>\",\n \"from\": \"<your-from>\",\n \"subject\": \"<your-subject>\",\n \"to\": \"<your-to>\"\n },\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: draftOrderInvoicePreview
"input EmailInput {\n bcc: [String!]\n body: String\n customMessage: String\n from: String\n subject: String\n to: String\n}\n"Display Examples for MUTATION: draftOrderInvoicePreview
[
{
"example": {
"type_name": "draftorderinvoicepreview",
"title": "Preview a draft order invoice by draft order ID",
"query_string": "mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n previewSubject\n }\n}",
"variables": {
"id": "gid://shopify/DraftOrder/276395349"
},
"response": {
"data": {
"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"
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/draft_orders/test/unit/graph_api/admin/mutations/draft_order_invoice_preview_test.rb",
"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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n previewSubject\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/DraftOrder/276395349\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "Specifies the draft order invoice email to preview.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/DraftOrder/276395349\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "draftorderinvoicepreview",
"title": "Preview a draft order invoice with custom email input",
"query_string": "mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {\n draftOrderInvoicePreview(id: $id, email: $email) {\n previewHtml\n previewSubject\n }\n}",
"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": {
"data": {
"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>Hi,<br>This is a custom message for the customer.</p>\n</body></html>\n",
"previewSubject": "Custom subject"
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/draft_orders/test/unit/graph_api/admin/mutations/draft_order_invoice_preview_test.rb",
"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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation draftOrderInvoicePreview($id: ID!, $email: EmailInput) {\n draftOrderInvoicePreview(id: $id, email: $email) {\n previewHtml\n previewSubject\n }\n }\nQUERY;\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$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "Specifies the draft order invoice email to preview.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/DraftOrder/276395349\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "email",
"description": "Specifies the draft order invoice email fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "EmailInput",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "EmailInput",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "email",
"argValue": " {\"to\":\"test@example.com\",\"subject\":\"Custom subject\",\"customMessage\":\"Hi,\\nThis is a custom message for the customer.\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "draftorderinvoicepreview",
"title": "Previewing a completed draft order returns an error",
"query_string": "mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n userErrors {\n message\n field\n }\n }\n}",
"variables": {
"id": "gid://shopify/DraftOrder/989355118"
},
"response": {
"data": {
"draftOrderInvoicePreview": {
"previewHtml": null,
"userErrors": [
{
"message": "Draft order Invoice can't be sent. This draft order is already paid.",
"field": null
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/draft_orders/test/unit/graph_api/admin/mutations/draft_order_invoice_preview_test.rb",
"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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation draftOrderInvoicePreview($id: ID!) {\n draftOrderInvoicePreview(id: $id) {\n previewHtml\n userErrors {\n message\n field\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/DraftOrder/989355118\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "Specifies the draft order invoice email to preview.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/DraftOrder/989355118\"",
"typeKind": "MUTATION"
}
]
}
]