Choose a version:

orderInvoiceSend

mutation

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

Sends an email invoice for an Order.

You can customize the email recipient, sender, and subject line using the email argument.

Note

Use store or staff account email addresses for the from and bcc input fields.

Anchor to Arguments

Arguments

Anchor to emailemail

•EmailInput

The email input fields for the order invoice. The bcc and from fields should be store or staff account emails.

Anchor to idid

•ID!

required

The order associated with the invoice.

Was this section helpful?

Anchor to OrderInvoiceSendPayload returnsOrderInvoiceSendPayload returns

Anchor to orderorder •Order: The order associated with the invoice email.
Anchor to userErrorsuserErrors •[OrderInvoiceSendUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Send invoice

Description

Send an order invoice to a customer.

Query

mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
  orderInvoiceSend(id: $orderId, email: $email) {
    order {
      id
    }
    userErrors {
      message
    }
  }
}

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) { orderInvoiceSend(id: $orderId, email: $email) { order { id } userErrors { message } } }",
 "variables": {
    "orderId": "gid://shopify/Order/17181286",
    "email": {
      "to": "test@example.net",
      "from": "Sales Modyl <salesmodel@example.com>",
      "subject": "Invoice #1001",
      "customMessage": "Thank you for your order"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
    orderInvoiceSend(id: $orderId, email: $email) {
      order {
        id
      }
      userErrors {
        message
      }
    }
  }`,
  {
    variables: {
        "orderId": "gid://shopify/Order/17181286",
        "email": {
            "to": "test@example.net",
            "from": "Sales Modyl <salesmodel@example.com>",
            "subject": "Invoice #1001",
            "customMessage": "Thank you for your order"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
    orderInvoiceSend(id: $orderId, email: $email) {
      order {
        id
      }
      userErrors {
        message
      }
    }
  }
QUERY

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

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
      orderInvoiceSend(id: $orderId, email: $email) {
        order {
          id
        }
        userErrors {
          message
        }
      }
    }`,
    "variables": {
        "orderId": "gid://shopify/Order/17181286",
        "email": {
            "to": "test@example.net",
            "from": "Sales Modyl <salesmodel@example.com>",
            "subject": "Invoice #1001",
            "customMessage": "Thank you for your order"
        }
    },
  },
});

Response

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

orderInvoiceSend reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {

orderInvoiceSend(id: $orderId, email: $email) {

order {

}

userErrors {

message

}

}`,

{

variables: {

"orderId": "gid://shopify/Order/17181286",

"email": {

"to": "test@example.net",

"from": "Sales Modyl <salesmodel@example.com>",

"subject": "Invoice #1001",

"customMessage": "Thank you for your order"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
  orderInvoiceSend(id: $orderId, email: $email) {
    order {
      id
    }
    userErrors {
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) { orderInvoiceSend(id: $orderId, email: $email) { order { id } userErrors { message } } }",
 "variables": {
    "orderId": "gid://shopify/Order/17181286",
    "email": {
      "to": "test@example.net",
      "from": "Sales Modyl <salesmodel@example.com>",
      "subject": "Invoice #1001",
      "customMessage": "Thank you for your order"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
    orderInvoiceSend(id: $orderId, email: $email) {
      order {
        id
      }
      userErrors {
        message
      }
    }
  }`,
  {
    variables: {
        "orderId": "gid://shopify/Order/17181286",
        "email": {
            "to": "test@example.net",
            "from": "Sales Modyl <salesmodel@example.com>",
            "subject": "Invoice #1001",
            "customMessage": "Thank you for your order"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
      orderInvoiceSend(id: $orderId, email: $email) {
        order {
          id
        }
        userErrors {
          message
        }
      }
    }`,
    "variables": {
        "orderId": "gid://shopify/Order/17181286",
        "email": {
            "to": "test@example.net",
            "from": "Sales Modyl <salesmodel@example.com>",
            "subject": "Invoice #1001",
            "customMessage": "Thank you for your order"
        }
    },
  },
});

Ruby

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 OrderInvoiceSend($orderId: ID!, $email: EmailInput) {
    orderInvoiceSend(id: $orderId, email: $email) {
      order {
        id
      }
      userErrors {
        message
      }
    }
  }
QUERY

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

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"orderId": "gid://shopify/Order/17181286",

"email": {

"to": "test@example.net",

"from": "Sales Modyl <salesmodel@example.com>",

"subject": "Invoice #1001",

"customMessage": "Thank you for your order"

}

Response

JSON

{

"orderInvoiceSend": {

"order": {

"id": "gid://shopify/Order/17181286"

"userErrors": []

}