Version: 2024-07
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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" 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" 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}"
input: { "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" } } }
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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" 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" 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}"
input: { "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" } } }
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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" 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" 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}"
input: { "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 } ] } } }