Get Purchase Order Details

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. A UID belonging to the other module (e.g. a Work Order UID fetched via /purchase_orders/:uid) returns 404.

get/purchase_orders/{purchase_order_uid}

Request

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

Path parameters

purchase_order_uidstring required

Query parameters

fields_to_selectstring

Sparse fieldset selector.

Response

200

type'success'
titlestring
messagestring
dataobject

Full document with populated references: job, estimate, asset, vendor, material_request, ship_to.product_location, project, parent_po, template, payment_term, line_items.product_ref_id, line_items.vendor_catalog, approval.await_approval, and appointments (expanded from UIDs to summaries).

Changes

    • info

      added the new optional query request parameter fields_to_select

    • info

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