Skip to main content

generateOrderPDF

Generate a PDF file for a Order using a Order template. Optionally also creates a new File object with the PDF data.

generateOrderPDF(
  id: ID!
  orderId: ID!
  file: GeneratePDFFileInput
): GeneratePDFPayload

Arguments​

generateOrderPDF.id ● ID! non-null scalar​

Template id to use for PDF generation.

generateOrderPDF.orderId ● ID! non-null scalar​

The order to generate a PDF from.

generateOrderPDF.file ● GeneratePDFFileInput input​

Input data for a new File entity containing the PDF contents. If the file argument is set (non-null), a new File entity will be created containing the PDF data. You can use the fields on the GeneratePDFFileInput objects to customize the newly created file. When file is not provided or null, a File entity will not be created.

Type​

GeneratePDFPayload object​

A newly generated PDF file