draftOrderInvoicePreview mutation

Version unstable

Previews a draft order invoice email.

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 invoice email to preview.

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

  • previewHtml (HTML)

    HTML to preview the draft order invoice email.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Previews a draft order invoice email.

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