draftOrderInvoicePreview

Previews a draft order invoice email.

Use it in a workflow

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

mutation DraftOrderInvoicePreview($id: ID!, $email: EmailInput) {
  draftOrderInvoicePreview(id: $id, email: $email) {
    previewHtml
    previewSubject
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

{
  "id": "string",
  "email": {
    "subject": "string",
    "to": "string",
    "from": "string",
    "body": "string",
    "bcc": [
      "string"
    ],
    "customMessage": "string"
  }
}

Response

Read the result with {{draftorderinvoicepreview.response.data.data.draftOrderInvoicePreview}}. If the API returns errors, the step fails and they are at {{draftorderinvoicepreview.response.data.errors}}.

Need more? See the Shopify guide for connection setup and behaviour shared by every action.