Send Purchase Order

Changed on

Operates on Purchase Orders. In the Zuper client app this module is labeled "Purchase Order" for most companies, and "Material Order" for companies in the roofing industry — the API and data shape are identical either way. Purchase Orders and Work Orders (Service Orders) share the exact same underlying schema and endpoints; they're distinguished only by the purchase_order_type field (PURCHASE_ORDER here) and the /purchase_orders vs /service_orders route prefix. If email is provided, sends the order by email and returns a JSON success message. If email is omitted, the response is instead a raw PDF (or Excel, if send_excel is true) binary stream, not JSON.

post/purchase_orders/{purchase_order_uid}/send

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/purchase_orders/{purchase_order_uid}/send
  • Auth
    API key in header x-api-key

Path parameters

purchase_order_uidstring required

Request body

emailstring
subjectstring
email_bodystring
email_ccstring[]
email_bccstring[]
email_config_uidstring
template_uidstring
attachmentsobject[]
send_pdfboolean

If true, sends/returns a PDF.

send_excelboolean

If true, sends/returns an Excel file instead of a PDF.

include_measurementsboolean
include_job_attachmentsboolean
include_productsboolean
from_status_updateboolean

Response

200

type'success'
titlestring

Exact wording is "Purchase Order" for most companies, or "Material Order" for roofing-industry companies.

messagestring

Exact wording is "Purchase Order" for most companies, or "Material Order" for roofing-industry companies.

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status