ZUzuper

Get Work Order Details

Changed on

Operates on Service Orders, shown in the Zuper client app as "Work Order" (in every industry). Work Orders share the exact same underlying schema and endpoints as Purchase Orders / Material Orders; they're distinguished only by the purchase_order_type field (SERVICE_ORDER here) and the /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/service_orders/{purchase_order_uid}

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/service_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