draftOrderInvoiceSend

mutation

Requires write_draft_orders access scope. Also: The user must have access to manage draft orders.

Sends an email invoice for a draft order.

Arguments

Anchor to emailemail • EmailInput: Specifies the draft order invoice email fields.
Anchor to idid • ID!required: Specifies the draft order to send the invoice for.

Was this section helpful?

Anchor to DraftOrderInvoiceSendPayload returnsDraftOrderInvoiceSendPayload returns

Anchor to draftOrderdraftOrder • DraftOrder: The draft order an invoice email is sent for.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Send a draft order invoice by draft order ID
Sending an invoice with invalid arguments returns an error
draftOrderInvoiceSend reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation draftOrderInvoiceSend($id: ID!) {
6    draftOrderInvoiceSend(id: $id) {
7      draftOrder {
8        id
9      }
10    }
11  }`,
12  {
13    variables: {
14      "id": "gid://shopify/DraftOrder/276395349"
15    },
16  },
17);
18
19const data = await response.json();
20

mutation draftOrderInvoiceSend($id: ID!) {
  draftOrderInvoiceSend(id: $id) {
    draftOrder {
      id
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderInvoiceSend($id: ID!) { draftOrderInvoiceSend(id: $id) { draftOrder { id } } }",
 "variables": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation draftOrderInvoiceSend($id: ID!) {
    draftOrderInvoiceSend(id: $id) {
      draftOrder {
        id
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/DraftOrder/276395349"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation draftOrderInvoiceSend($id: ID!) {
      draftOrderInvoiceSend(id: $id) {
        draftOrder {
          id
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DraftOrder/276395349"
    },
  },
});

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 draftOrderInvoiceSend($id: ID!) {
    draftOrderInvoiceSend(id: $id) {
      draftOrder {
        id
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DraftOrder/276395349"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/DraftOrder/276395349"
3}

Response

JSON

1{
2  "draftOrderInvoiceSend": {
3    "draftOrder": {
4      "id": "gid://shopify/DraftOrder/276395349"
5    }
6  }
7}