# draftOrderInvoiceSend - admin-graphql - MUTATION Version: 2024-07 ## Description Sends an email invoice for a draft order. ### Access Scopes `write_draft_orders` access scope. Also: The user must have access to manage draft orders. ## Arguments * [email](/docs/api/admin-graphql/2024-07/input-objects/EmailInput): EmailInput - Specifies the draft order invoice email fields. * [id](/docs/api/admin-graphql/2024-07/scalars/ID): ID! - Specifies the draft order to send the invoice for. ## Returns * [draftOrder](/docs/api/admin-graphql/2024-07/objects/DraftOrder): DraftOrder The draft order an invoice email is sent for. * [userErrors](/docs/api/admin-graphql/2024-07/objects/UserError): UserError! The list of errors that occurred from executing the mutation. ## Examples ### Send a draft order invoice by draft order ID 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 draftOrderInvoiceSend($id: ID!) { draftOrderInvoiceSend(id: $id) { draftOrder { id } } }\",\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 draftOrderInvoiceSend($id: ID!) {\n draftOrderInvoiceSend(id: $id) {\n draftOrder {\n id\n }\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 draftOrderInvoiceSend($id: ID!) {\n draftOrderInvoiceSend(id: $id) {\n draftOrder {\n id\n }\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 draftOrderInvoiceSend($id: ID!) {\n draftOrderInvoiceSend(id: $id) {\n draftOrder {\n id\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation draftOrderInvoiceSend($id: ID!) {\n draftOrderInvoiceSend(id: $id) {\n draftOrder {\n id\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/DraftOrder/276395349" } #### Graphql Response { "data": { "draftOrderInvoiceSend": { "draftOrder": { "id": "gid://shopify/DraftOrder/276395349" } } } } ### Sending an invoice with invalid arguments returns an error 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 draftOrderInvoiceSend($id: ID!, $email: EmailInput) { draftOrderInvoiceSend(id: $id, email: $email) { draftOrder { id } userErrors { message field } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"subject\": \"valid subject\",\n \"to\": \"invalid recipient\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderInvoiceSend($id: ID!, $email: EmailInput) {\n draftOrderInvoiceSend(id: $id, email: $email) {\n draftOrder {\n id\n }\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"subject\": \"valid subject\",\n \"to\": \"invalid recipient\"\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 draftOrderInvoiceSend($id: ID!, $email: EmailInput) {\n draftOrderInvoiceSend(id: $id, email: $email) {\n draftOrder {\n id\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"subject\": \"valid subject\",\n \"to\": \"invalid recipient\"\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 draftOrderInvoiceSend($id: ID!, $email: EmailInput) {\n draftOrderInvoiceSend(id: $id, email: $email) {\n draftOrder {\n id\n }\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"email\": {\n \"subject\": \"valid subject\",\n \"to\": \"invalid recipient\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation draftOrderInvoiceSend($id: ID!, $email: EmailInput) {\n draftOrderInvoiceSend(id: $id, email: $email) {\n draftOrder {\n id\n }\n userErrors {\n message\n field\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/DraftOrder/276395349", "email": { "subject": "valid subject", "to": "invalid recipient" } } #### Graphql Response { "data": { "draftOrderInvoiceSend": { "draftOrder": { "id": "gid://shopify/DraftOrder/276395349" }, "userErrors": [ { "message": "To is invalid", "field": null } ] } } }