orderInvoiceSend - admin-graphql - MUTATION

Version: 2024-10

Description:

Sends an email invoice for an order.

Access Scopes

`write_orders` access scope. Also: The user must have access to orders and manage orders information.

Arguments

• email: EmailInput - The email input fields for the order invoice. The `bcc` and `from` fields should be store or staff account emails.
• id: ID! - The order associated with the invoice.

Returns

• order: Order The order associated with the invoice email.
• userErrors: OrderInvoiceSendUserError! The list of errors that occurred from executing the mutation.

Examples

• Send invoice

          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 OrderInvoiceSend($orderId: ID!, $email: EmailInput) { orderInvoiceSend(id: $orderId, email: $email) { order { id } userErrors { message } } }\",\n \"variables\": {\n    \"orderId\": \"gid://shopify/Order/17181286\",\n    \"email\": {\n      \"to\": \"test@example.net\",\n      \"from\": \"Sales Modyl \",\n      \"subject\": \"Invoice #1001\",\n      \"customMessage\": \"Thank you for your order\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {\n      orderInvoiceSend(id: $orderId, email: $email) {\n        order {\n          id\n        }\n        userErrors {\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"orderId\": \"gid://shopify/Order/17181286\",\n      \"email\": {\n        \"to\": \"test@example.net\",\n        \"from\": \"Sales Modyl \",\n        \"subject\": \"Invoice #1001\",\n        \"customMessage\": \"Thank you for your order\"\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 OrderInvoiceSend($orderId: ID!, $email: EmailInput) {\n    orderInvoiceSend(id: $orderId, email: $email) {\n      order {\n        id\n      }\n      userErrors {\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"orderId\": \"gid://shopify/Order/17181286\",\n  \"email\": {\n    \"to\": \"test@example.net\",\n    \"from\": \"Sales Modyl \",\n    \"subject\": \"Invoice #1001\",\n    \"customMessage\": \"Thank you for your order\"\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 = << \"gid://shopify/Order/17181286\",\n  \"email\" => [\n    \"to\" => \"test@example.net\",\n    \"from\" => \"Sales Modyl \",\n    \"subject\" => \"Invoice #1001\",\n    \"customMessage\" => \"Thank you for your order\",\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 OrderInvoiceSend($orderId: ID!, $email: EmailInput) {\n    orderInvoiceSend(id: $orderId, email: $email) {\n      order {\n        id\n      }\n      userErrors {\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"orderId\": \"gid://shopify/Order/17181286\",\n      \"email\": {\n        \"to\": \"test@example.net\",\n        \"from\": \"Sales Modyl \",\n        \"subject\": \"Invoice #1001\",\n        \"customMessage\": \"Thank you for your order\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {\n  orderInvoiceSend(id: $orderId, email: $email) {\n    order {\n      id\n    }\n    userErrors {\n      message\n    }\n  }\n}"
        

  input: {
    "orderId": "gid://shopify/Order/17181286",
    "email": {
      "to": "test@example.net",
      "from": "Sales Modyl ",
      "subject": "Invoice #1001",
      "customMessage": "Thank you for your order"
    }
  }

  response: {
    "data": {
      "orderInvoiceSend": {
        "order": {
          "id": "gid://shopify/Order/17181286"
        },
        "userErrors": []
      }
    }
  }