API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

draftOrderInvoiceSend mutation

Version unstable

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-07 (Release candidate)

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Latest)

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Sends an email invoice for a draft order.

Required access

write_draft_orders access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
email ( EmailInput )

Specifies the draft order invoice email fields.

id ( ID! ) required

Specifies the draft order to send the invoice for.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • draftOrder (DraftOrder)

    The draft order an invoice email is sent for.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.